Package com.ironsoftware.ironpdf.internal.staticapi

Class Metadata_Api

  • public final class Metadata_Api
extends Object
    The type Metadata api.

    • Constructor Detail

      • Metadata_Api

        public Metadata_Api()

    • Method Detail

      • getAuthor

        public static String getAuthor​(InternalPdfDocument internalPdfDocument)
        Gets the Author of the document.
        Parameters:
        internalPdfDocument - the internal pdf document
        Returns:
        the author

      • getMetadata

        public static String getMetadata​(InternalPdfDocument internalPdfDocument,
                                 String key)
        Gets any metadata value of the document form given key.
        Parameters:
        internalPdfDocument - the internal pdf document
        key - the key
        Returns:
        the metadata

      • setAuthor

        public static void setAuthor​(InternalPdfDocument internalPdfDocument,
                             String value)
        Sets the Author of the document.
        Parameters:
        internalPdfDocument - the internal pdf document
        value - the value

      • setMetadata

        public static void setMetadata​(InternalPdfDocument internalPdfDocument,
                               String key,
                               String value)
        Sets any metadata value of the document form given key.
        Parameters:
        internalPdfDocument - the internal pdf document
        key - the key
        value - the value

      • getCreationDate

        public static String getCreationDate​(InternalPdfDocument internalPdfDocument)
        Gets the PDF file creation DateTime.
        Parameters:
        internalPdfDocument - the internal pdf document
        Returns:
        the creation date

      • setCreationDate

        public static void setCreationDate​(InternalPdfDocument internalPdfDocument,
                                   String value)
        Sets the PDF file creation DateTime.
        Parameters:
        internalPdfDocument - the internal pdf document
        value - the value

      • getModifiedDate

        public static String getModifiedDate​(InternalPdfDocument internalPdfDocument)
        Gets the PDF file last-modified DateTime.
        Parameters:
        internalPdfDocument - the internal pdf document
        Returns:
        the modified date

      • setModifiedDate

        public static void setModifiedDate​(InternalPdfDocument internalPdfDocument,
                                   String value)
        Gets the PDF file last-modified DateTime.
        Parameters:
        internalPdfDocument - the internal pdf document
        value - the value

      • getCreator

        public static String getCreator​(InternalPdfDocument internalPdfDocument)
        Gets the Creator of the document.
        Parameters:
        internalPdfDocument - the internal pdf document
        Returns:
        the creator

      • setCreator

        public static void setCreator​(InternalPdfDocument internalPdfDocument,
                              String value)
        Sets the Creator of the document.
        Parameters:
        internalPdfDocument - the internal pdf document
        value - the value

      • getKeywords

        public static String getKeywords​(InternalPdfDocument internalPdfDocument)
        Gets Keywords of the document. This helps search indexes and operating systems correctly index the PDF.
        Parameters:
        internalPdfDocument - the internal pdf document
        Returns:
        the keywords

      • setKeywords

        public static void setKeywords​(InternalPdfDocument internalPdfDocument,
                               String value)
        Sets Keywords of the document. This helps search indexes and operating systems correctly index the PDF.
        Parameters:
        internalPdfDocument - the internal pdf document
        value - the value

      • getProducer

        public static String getProducer​(InternalPdfDocument internalPdfDocument)
        Gets the Producer of the document.
        Parameters:
        internalPdfDocument - the internal pdf document
        Returns:
        the producer

      • setProducer

        public static void setProducer​(InternalPdfDocument internalPdfDocument,
                               String value)
        Sets the Producer of the document.
        Parameters:
        internalPdfDocument - the internal pdf document
        value - the value

      • getSubject

        public static String getSubject​(InternalPdfDocument internalPdfDocument)
        Gets Subject of the document. This helps search indexes and operating systems correctly index the PDF, and may appear in PDF viewer software.
        Parameters:
        internalPdfDocument - the internal pdf document
        Returns:
        the subject

      • setSubject

        public static void setSubject​(InternalPdfDocument internalPdfDocument,
                              String value)
        Sets the Subject of the document. This helps search indexes and operating systems correctly index the PDF, and may appear in PDF viewer software.
        Parameters:
        internalPdfDocument - the internal pdf document
        value - the value

      • getTitle

        public static String getTitle​(InternalPdfDocument internalPdfDocument)
        Gets the Title of the document. This helps search indexes and operating systems correctly index the PDF, and may appear in PDF viewer software.
        Parameters:
        internalPdfDocument - the internal pdf document
        Returns:
        the title

      • setTitle

        public static void setTitle​(InternalPdfDocument internalPdfDocument,
                            String value)
        Sets the Title of the document. This helps search indexes and operating systems correctly index the PDF, and may appear in PDF viewer software.
        Parameters:
        internalPdfDocument - the internal pdf document
        value - the value

      • removeMetadata

        public static void removeMetadata​(InternalPdfDocument internalPdfDocument,
                                  String key)
        Method for removing Metadata property by its name.
        Parameters:
        internalPdfDocument - the internal pdf document
        key - The name of the property.