com.groupdocs.metadata

Interfaces

Classes

Exceptions

com.groupdocs.metadata

Class PsdFormat

    • Constructor Detail

      • PsdFormat

        public PsdFormat(String fileName)

        Initializes a new instance of the PsdFormat class.

        Parameters:
        fileName - A string that contains the full name of the file from which to create a PsdFormat instance.
      • PsdFormat

        public PsdFormat(InputStream input)

        Initializes a new instance of the PsdFormat class.

        Parameters:
        input - A stream that contains the data for this PsdFormat.
    • Method Detail

      • getType

        public int getType()

        Gets the type of the loaded file.

        Specified by:
        getType in class FormatBase
        Returns:
        The type of the loaded file.
      • hasXmp

        public final boolean hasXmp()

        Gets a value indicating whether the file contains XMP metadata.

        Specified by:
        hasXmp in interface IXmp
        Returns:
        true if the file contains an XMP metadata package; otherwise, false.
      • getLayers

        public final PsdLayer[] getLayers()

        Gets the Photoshop layers.

        Returns:
        The Photoshop layers.
      • getXmpValues

        public final XmpEditableCollection getXmpValues()

        Gets a collection containing the XMP metadata properties. Provides access to all XMP properties in edit mode.

        Specified by:
        getXmpValues in interface IXmp
        Returns:
        The XMP values.
      • getIptcValues

        public final IptcDataSetCollection getIptcValues()

        Gets the IPTC metadata package associated with the file.

        Specified by:
        getIptcValues in interface IIptc
        Returns:
        The IPTC metadata package associated with the file.
      • setIptcValues

        public final void setIptcValues(IptcDataSetCollection value)

        Sets the IPTC metadata package associated with the file.

        Specified by:
        setIptcValues in interface IIptc
        Parameters:
        value - The IPTC metadata package associated with the file.
      • hasIptc

        @Deprecated
        public final boolean hasIptc()
        Deprecated. 

        Gets a value indicating whether the PSD file contains IPTC IIM metadata.

        Specified by:
        hasIptc in interface IIptc
        Returns:
        true if the image has IPTC IIM metadata; otherwise, false.
      • hasImageResourceBlocks

        public final boolean hasImageResourceBlocks()

        Gets true if file contains Photoshop Image Resource Blocks.

        Specified by:
        hasImageResourceBlocks in interface IImageResourceBlocks
        Returns:
        true if file has image resource blocks; otherwise, false.
      • getExifInfo

        public final ExifInfo getExifInfo()

        Returns EXIF data.

        Returns:
        ExifInfo if image contains EXIF data; otherwise null.
      • getXmpData

        public final XmpPacketWrapper getXmpData()

        Returns the XMP packet.

        Specified by:
        getXmpData in interface IXmp
        Returns:
        The XmpPacketWrapper if the file contains an XMP metadata package; otherwise, null.
      • getXmpProperties

        public final XmpProperties getXmpProperties()

        Returns all XMP properties presented in a specific format.

        Specified by:
        getXmpProperties in interface IXmp
        Returns:
        The XmpProperties if the file contains an XMP metadata package; otherwise, null.
      • setXmpData

        public final boolean setXmpData(XmpPacketWrapper package_)

        Updates the XMP packet.

        Specified by:
        setXmpData in interface IXmp
        Parameters:
        package - An XMP packet wrapper.
        Returns:
        true if the XMP package is successfully updated; otherwise, false.
      • removeXmpData

        public final void removeXmpData()

        Removes the XMP metadata.


        This feature is not available in trial mode.

        Specified by:
        removeXmpData in interface IXmp
      • getDublinCore

        public final DublinCoreMetadata getDublinCore()

        Retrieves the Dublin Core metadata.

        Specified by:
        getDublinCore in interface IDublinCore
        Returns:
        The DublinCoreMetadata if the appropriate package is found; otherwise, null.
      • cleanMetadata

        public void cleanMetadata()

        Removes writable metadata properties associated with the file.


        This feature is not available in trial mode.

        Overrides:
        cleanMetadata in class ImageFormat
      • getPsdInfo

        public final PsdMetadata getPsdInfo()

        Gets native Photoshop metadata.

        Returns:
        The PsdMetadata.
      • updateIptc

        @Deprecated
        public final void updateIptc(IptcCollection collection)
        Deprecated. 

        Updates IPTC metadata.

        Specified by:
        updateIptc in interface IIptc
        Parameters:
        collection - An IPTC collection.
        Throws:
        ArgumentNullException - The collection could not be null.
      • updateIptc

        @Deprecated
        public final void updateIptc(IptcDataSet dataSet)
        Deprecated. 

        Updates a specific IPTC dataset.

        Specified by:
        updateIptc in interface IIptc
        Parameters:
        dataSet - An IPTC dataset.
        Throws:
        ArgumentNullException - The DataSet could not be null.
      • removeIptc

        @Deprecated
        public final void removeIptc()
        Deprecated. 

        Removes IPTC metadata from the image.

        Specified by:
        removeIptc in interface IIptc