com.groupdocs.signature.domain.signatures.metadata

Class ImageMetadataSignature

java.lang.Object

com.groupdocs.signature.domain.signatures.BaseSignature

com.groupdocs.signature.domain.signatures.metadata.MetadataSignature

com.groupdocs.signature.domain.signatures.metadata.ImageMetadataSignature

public final class ImageMetadataSignature
extends MetadataSignature

Contains Image Metadata signature properties.

Constructor Summary

Constructors

Constructor and Description
ImageMetadataSignature(int id, Object value) Creates Image Metadata Signature with Id and value

Method Summary

Modifier and Type	Method and Description
Object	deepClone() Clone Metadata Signature instance.
MetadataSignature	deepClone(Object value) Clone Image Metadata Signature instance with given value.
boolean	equals(Object signature) Overwrites Equals method to compare signature properties
String	getDescription() Read-only value to get description for standard Image Metadata signature
int	getId() The identifier of Image Metadata signature.
int	getSize() Read-only value to get size of Metadata value
int	hashCode() Overrides GetHashCode method
boolean	setAsBool(Object value)
boolean	setAsByte(Object value)
boolean	setAsDate(Object value)
boolean	setAsDbls(Object value)
boolean	setAsDcml(Object value)
boolean	setAsObjc(Object value)
boolean	setAsShrt(Object value)
boolean	setAsSInt(Object value)
boolean	setAsSLng(Object value)
boolean	setAsSngl(Object value)
boolean	setAsStrn(Object value)
boolean	setAsUInt(Object value)
boolean	setAsULng(Object value)
boolean	setAsWord(Object value)
void	setId(int value) The identifier of Image Metadata signature.
void	setSize(int value) Read-only value to get size of Metadata value
void	setString(Object value)
boolean	toBoolean() Converts to boolean.
Date	toDateTime() Converts to DateTime.
Date	toDateTime(Locale provider) Converts to DateTime.
BigDecimal	toDecimal() Converts to Decimal.
BigDecimal	toDecimal(Locale provider) Converts to Decimal.
double	toDouble() Converts to Double.
double	toDouble(Locale provider) Converts to Double.
int	toInteger() Converts to integer.
long	toLong() Converts to long.
float	toSingle() Converts to float.
float	toSingle(Locale provider) Converts to float.
String	toString() Converts to String with override ToString() method
String	toString(String format) Converts to String with specified format
String	toString(String format, Locale provider) Converts to String with specified format

Methods inherited from class com.groupdocs.signature.domain.signatures.metadata.MetadataSignature

getData, getData, getDataEncryption, getFValue, getName, getType, getValue, setDataEncryption, setFValue, setName, setType, setValue, SetValue

Methods inherited from class com.groupdocs.signature.domain.signatures.BaseSignature

getCreatedOn, getDeleted, getHeight, getLeft, getModifiedOn, getPageNumber, getSignatureId, getSignatureType, getTop, getWidth, isSignature, setCreatedOn, setHeight, setLeft, setModifiedOn, setPageNumber, setSignature, setTop, setWidth, supportMetaInfoLayer

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

setAsBool

public final boolean setAsBool(Object value)

setAsByte

public final boolean setAsByte(Object value)

setAsDate

public final boolean setAsDate(Object value)

setAsDbls

public final boolean setAsDbls(Object value)

setAsDcml

public final boolean setAsDcml(Object value)

setAsObjc

public final boolean setAsObjc(Object value)

setAsShrt

public final boolean setAsShrt(Object value)

setAsSInt

public final boolean setAsSInt(Object value)

setAsSLng

public final boolean setAsSLng(Object value)

setAsSngl

public final boolean setAsSngl(Object value)

setAsStrn

public final boolean setAsStrn(Object value)

setAsUInt

public final boolean setAsUInt(Object value)

setAsULng

public final boolean setAsULng(Object value)

setAsWord

public final boolean setAsWord(Object value)

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

setString

public final void setString(Object 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