Package pdf

Class PDFInfo

  • All Implemented Interfaces:
    java.io.Serializable
    public class PDFInfo
extends PDFObject

    This class stores details of the author, the PDF generator etc. The values are accessible via the PDFDocument class.

    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      PDFInfo()
      This constructs a minimal info object
      PDFInfo​(java.lang.String title)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAuthor()
      Get the value of author.
      java.lang.String getCreator()
      PDF has two values, a Creator and a Producer.
      java.lang.String getKeywords()
      Get the value of keywords.
      java.lang.String getSubject()
      Get the value of subject.
      java.lang.String getTitle()
      Get the value of title.
      void setAuthor​(java.lang.String v)
      Set the value of author.
      void setCreator​(java.lang.String v)
      Set the value of creator.
      void setKeywords​(java.lang.String v)
      Set the value of keywords.
      void setSubject​(java.lang.String v)
      Set the value of subject.
      void setTitle​(java.lang.String v)
      Set the value of title.
      void write​(java.io.OutputStream os)
      Writes the object to the output stream.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • PDFInfo

        public PDFInfo()
        This constructs a minimal info object

      • PDFInfo

        public PDFInfo​(java.lang.String title)
        Parameters:
        title - Title of this document

    • Method Detail

      • getAuthor

        public java.lang.String getAuthor()
        Get the value of author.
        Returns:
        value of author.

      • setAuthor

        public void setAuthor​(java.lang.String v)
        Set the value of author.
        Parameters:
        v - Value to assign to author.

      • getCreator

        public java.lang.String getCreator()
        PDF has two values, a Creator and a Producer. The creator field is available for calling code. The producer is fixed by this library. Get the value of creator.
        Returns:
        value of creator.

      • setCreator

        public void setCreator​(java.lang.String v)
        Set the value of creator.
        Parameters:
        v - Value to assign to creator.

      • getTitle

        public java.lang.String getTitle()
        Get the value of title.
        Returns:
        value of title.

      • setTitle

        public void setTitle​(java.lang.String v)
        Set the value of title.
        Parameters:
        v - Value to assign to title.

      • getSubject

        public java.lang.String getSubject()
        Get the value of subject.
        Returns:
        value of subject.

      • setSubject

        public void setSubject​(java.lang.String v)
        Set the value of subject.
        Parameters:
        v - Value to assign to subject.

      • getKeywords

        public java.lang.String getKeywords()
        Get the value of keywords.
        Returns:
        value of keywords.

      • setKeywords

        public void setKeywords​(java.lang.String v)
        Set the value of keywords.
        Parameters:
        v - Value to assign to keywords.

      • write

        public void write​(java.io.OutputStream os)
           throws java.io.IOException
        Description copied from class: PDFObject

        Writes the object to the output stream. This method must be overidden.

        Note: It should not write any other objects, even if they are it's Kids, as they will be written by the calling routine.

        Specified by:
        write in class PDFObject
        Parameters:
        os - OutputStream to send the object to
        Throws:
        java.io.IOException - on error