Package com.pdftools.pdf

Class MetadataSettings

java.lang.Object
com.pdftools.internal.NativeBase
com.pdftools.internal.NativeObject
com.pdftools.pdf.MetadataSettings
public class MetadataSettings extends NativeObject
It allows you to set and update individual metadata properties. Any metadata properties that have been explicitly set are included in the output document.

  • Constructor Details

    • MetadataSettings

      public MetadataSettings()

  • Method Details

    • getTitle

      public String getTitle()

      The title of the document or resource. (Getter)

      This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.
      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • setTitle

      public void setTitle(String value)

      The title of the document or resource. (Setter)

      This property corresponds to the "dc:title" entry in the XMP metadata and to the "Title" entry in the document information dictionary.
      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • getAuthor

      public String getAuthor()

      The name of the person who created the document or resource. (Getter)

      This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.
      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • setAuthor

      public void setAuthor(String value)

      The name of the person who created the document or resource. (Setter)

      This property corresponds to the "dc:creator" entry in the XMP metadata and to the "Author" entry in the document information dictionary.
      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • getSubject

      public String getSubject()

      The subject of the document or resource. (Getter)

      This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.
      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • setSubject

      public void setSubject(String value)

      The subject of the document or resource. (Setter)

      This property corresponds to the "dc:description" entry in the XMP metadata and to the "Subject" entry in the document information dictionary.
      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • getKeywords

      public String getKeywords()

      Keywords associated with the document or resource. (Getter)

      Keywords can be separated by:

      • carriage return / line feed
      • comma
      • semicolon
      • tab
      • double space

      This property corresponds to the "pdf:Keywords" entry in the XMP metadata and to the "Keywords" entry in the document information dictionary.

      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • setKeywords

      public void setKeywords(String value)

      Keywords associated with the document or resource. (Setter)

      Keywords can be separated by:

      • carriage return / line feed
      • comma
      • semicolon
      • tab
      • double space

      This property corresponds to the "pdf:Keywords" entry in the XMP metadata and to the "Keywords" entry in the document information dictionary.

      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • getCreator

      public String getCreator()

      The original application that created the document. (Getter)

      The name of the first known tool used to create the document or resource.

      This property corresponds to the "xmp:CreatorTool" entry in the XMP metadata and to the "Creator" entry in the document information dictionary.

      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • setCreator

      public void setCreator(String value)

      The original application that created the document. (Setter)

      The name of the first known tool used to create the document or resource.

      This property corresponds to the "xmp:CreatorTool" entry in the XMP metadata and to the "Creator" entry in the document information dictionary.

      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • getProducer

      public String getProducer()

      The application that created the PDF (Getter)

      If the document has been converted to PDF from another format, the name of the PDF processor that converted the document to PDF.

      This property corresponds to the "pdf:Producer" entry in the XMP metadata and to the "Producer" entry in the document information dictionary.

      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • setProducer

      public void setProducer(String value)

      The application that created the PDF (Setter)

      If the document has been converted to PDF from another format, the name of the PDF processor that converted the document to PDF.

      This property corresponds to the "pdf:Producer" entry in the XMP metadata and to the "Producer" entry in the document information dictionary.

      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • getCreationDate

      public OffsetDateTime getCreationDate()

      The date and time the document or resource was originally created. (Getter)

      This property corresponds to the "xmp:CreateDate" entry in the XMP metadata and to the "CreationDate" entry in the document information dictionary.
      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • setCreationDate

      public void setCreationDate(OffsetDateTime value)

      The date and time the document or resource was originally created. (Setter)

      This property corresponds to the "xmp:CreateDate" entry in the XMP metadata and to the "CreationDate" entry in the document information dictionary.
      Throws:
      IllegalStateException - If the metadata settings have already been closed
      IllegalArgumentException - The date is invalid.

    • getModificationDate

      public OffsetDateTime getModificationDate()

      The date and time the document or resource was most recently modified. (Getter)

      This property corresponds to the "xmp:ModifyDate" entry in the XMP metadata and to the "ModDate" entry in the document information dictionary.
      Throws:
      IllegalStateException - If the metadata settings have already been closed

    • setModificationDate

      public void setModificationDate(OffsetDateTime value)

      The date and time the document or resource was most recently modified. (Setter)

      This property corresponds to the "xmp:ModifyDate" entry in the XMP metadata and to the "ModDate" entry in the document information dictionary.
      Throws:
      IllegalStateException - If the metadata settings have already been closed
      IllegalArgumentException - The date is invalid.