com.groupdocs.signature.domain.signatures.metadata

Class ImageMetadataSignature



  • public final class ImageMetadataSignature
    extends MetadataSignature

    Contains Image Metadata signature properties.

    • Constructor Detail

      • ImageMetadataSignature

        public ImageMetadataSignature(int id,
                                      Object value)

        Creates Image Metadata Signature with Id and value

        Parameters:
        id - Unique identifier Image Metadata Signature name. See references for Exif tags specifications for possible id values
        value - Metadata value
    • Method Detail

      • deepClone

        public Object deepClone()

        Clone Metadata Signature instance.

        Overrides:
        deepClone in class MetadataSignature
        Returns:
        Returns cloned Metadata Signature instance
      • deepClone

        public MetadataSignature deepClone(Object value)

        Clone Image Metadata Signature instance with given value.

        Overrides:
        deepClone in class MetadataSignature
        Parameters:
        value - Value for new cloned object.
        Returns:
        Returns cloned Metadata Signature instance.
      • equals

        public boolean equals(Object signature)

        Overwrites Equals method to compare signature properties

        Overrides:
        equals in class MetadataSignature
        Parameters:
        signature - Signature object to compare with.
        Returns:
        Returns true if passed signature object has same type and all its properties are equal to this instance properties.
      • getDescription

        public final String getDescription()

        Read-only value to get description for standard Image Metadata signature

      • getId

        public final int getId()

        The identifier of Image Metadata signature. See ImageMetadataSignatures class that contains standard Signature with predefined Id value.

      • getSize

        public final int getSize()

        Read-only value to get size of Metadata value

      • hashCode

        public int hashCode()

        Overrides GetHashCode method

        Overrides:
        hashCode in class MetadataSignature
        Returns:
        Signature hash code
      • setId

        public final void setId(int value)

        The identifier of Image Metadata signature. See ImageMetadataSignatures class that contains standard Signature with predefined Id value.

      • setSize

        public final void setSize(int value)

        Read-only value to get size of Metadata value

      • toBoolean

        public boolean toBoolean()
                          throws Exception

        Converts to boolean.

        Overrides:
        toBoolean in class MetadataSignature
        Returns:
        Returns the Metadata signature value as boolean.


        Throws an exception if the Metadata value could not be converted.
        Throws:
        Exception
      • toDateTime

        public Date toDateTime()
                        throws Exception

        Converts to DateTime.

        Overrides:
        toDateTime in class MetadataSignature
        Returns:
        Returns the Metadata Signature value as DateTime.


        Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties SignatureSettings.DefaultCulture
        Throws:
        Exception
      • toDateTime

        public Date toDateTime(Locale provider)
                        throws Exception

        Converts to DateTime.

        Overrides:
        toDateTime in class MetadataSignature
        Parameters:
        provider - Format data provider to use with data conversion operations.


        Throws an exception if the Metadata value could not be converted
        Returns:
        Returns the Metadata Signature value as DateTime.
        Throws:
        Exception
      • toDecimal

        public final BigDecimal toDecimal()
                                   throws Exception

        Converts to Decimal.

        Returns:
        Returns the Image Metadata Signature value as Decimal.


        Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties SignatureSettings.DefaultCulture
        Throws:
        Exception
      • toDecimal

        public final BigDecimal toDecimal(Locale provider)
                                   throws Exception

        Converts to Decimal.

        Parameters:
        provider - Format data provider to use with data conversion operations.


        Throws an exception if the Metadata value could not be converted
        Returns:
        Returns the Metadata Signature value as Decimal.
        Throws:
        Exception
      • toDouble

        public double toDouble()
                        throws Exception

        Converts to Double.

        Overrides:
        toDouble in class MetadataSignature
        Returns:
        Returns the Image Metadata Signature value as Double.


        Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties SignatureSettings.DefaultCulture
        Throws:
        Exception
      • toDouble

        public double toDouble(Locale provider)
                        throws Exception

        Converts to Double.

        Overrides:
        toDouble in class MetadataSignature
        Parameters:
        provider - Format data provider to use with data conversion operations.


        Throws an exception if the Metadata value could not be converted
        Returns:
        Returns the Metadata Signature value as Double.
        Throws:
        Exception
      • toInteger

        public int toInteger()
                      throws Exception

        Converts to integer.

        Overrides:
        toInteger in class MetadataSignature
        Returns:
        Returns the Metadata Signature value as integer.


        Throws an exception if the Metadata value could not be converted.
        Throws:
        Exception
      • toLong

        public final long toLong()
                          throws Exception

        Converts to long.

        Returns:
        Returns the Metadata Signature value as long.


        Throws an exception if the Metadata value could not be converted.
        Throws:
        Exception
      • toSingle

        public final float toSingle()
                             throws Exception

        Converts to float.

        Overrides:
        toSingle in class MetadataSignature
        Returns:
        Returns the Image Metadata Signature value as float.


        Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties SignatureSettings.DefaultCulture
        Throws:
        Exception
      • toSingle

        public final float toSingle(Locale provider)
                             throws Exception

        Converts to float.

        Overrides:
        toSingle in class MetadataSignature
        Parameters:
        provider - Format data provider to use with data conversion operations.


        Throws an exception if the Metadata value could not be converted
        Returns:
        Returns the Metadata Signature value as float.
        Throws:
        Exception
      • toString

        public String toString()

        Converts to String with override ToString() method

        Overrides:
        toString in class MetadataSignature
        Returns:
        Returns the Metadata Signature value as String.
      • toString

        public String toString(String format)
                        throws Exception

        Converts to String with specified format

        Overrides:
        toString in class MetadataSignature
        Parameters:
        format - Data format string.


        Converts a boolean property into "True" or "False". Default culture property info will be used from SignatureSettings properties SignatureSettings.DefaultCulture
        Returns:
        Returns the Metadata Signature value as String.
        Throws:
        Exception
      • toString

        public String toString(String format,
                               Locale provider)
                        throws Exception

        Converts to String with specified format

        Overrides:
        toString in class MetadataSignature
        Parameters:
        format - Data format string.
        provider - Format data provider to use with data conversion operations.


        Converts a boolean property into "True" or "False".
        Returns:
        Returns the Metadata Signature value as String.
        Throws:
        Exception