com.groupdocs.signature.options.sign

Class MetadataSignOptions

java.lang.Object

com.groupdocs.signature.options.sign.SignOptions

com.groupdocs.signature.options.sign.MetadataSignOptions

public class MetadataSignOptions
extends SignOptions

Represents Metadata signature options.

Constructor Summary

Constructors

Constructor and Description
MetadataSignOptions() Initializes a new instance of the SignMetadataOptions class with default values.
MetadataSignOptions(ArrayList<MetadataSignature> signatures) Initializes a new instance of the SignMetadataOptions class with Metadata.

Method Summary

Modifier and Type	Method and Description
MetadataSignOptions	add(MetadataSignature metadataSignature) Add existing MetadataSignature instance to collection.
ImageMetadataSignature	addImageSignature(int id, Object value) Creates new ImageMetadataSignature with passed arguments and adds it to collection.
PdfMetadataSignature	addPdfSignature(String name, Object value, String tag) Creates new PdfMetadataSignature with passed arguments and adds it to collection.
IDataEncryption	getDataEncryption() Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
MetadataSignatureCollection	getSignatures() Gets or sets the Metadata of signature.
void	setDataEncryption(IDataEncryption value) Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
void	setSignatures(MetadataSignatureCollection value) Gets or sets the Metadata of signature.
BaseSignature	signature()
String	toString() Override string conversion.
void	validate() Internal method to validate the options parameters.

Methods inherited from class com.groupdocs.signature.options.sign.SignOptions

addSignature, getAllPages, getAppearance, getDocumentType, getExtensions, getPageNumber, getPagesSetup, getSignatureType, getZOrder, setAllPages, setAppearance, setDocumentType, setExtensions, setPageNumber, setPagesSetup, setZOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MetadataSignOptions

public MetadataSignOptions()

Initializes a new instance of the SignMetadataOptions class with default values.

MetadataSignOptions

public MetadataSignOptions(ArrayList<MetadataSignature> signatures)
                    throws Exception

Initializes a new instance of the SignMetadataOptions class with Metadata.

Parameters:

signatures - Collection of Metadata Signatures MetadataSignature.

Throws:

Exception

Method Detail

add

public final MetadataSignOptions add(MetadataSignature metadataSignature)

Add existing MetadataSignature instance to collection.

Parameters:

metadataSignature - The existing MetadataSignature instance to be added

Returns:

Instance itself

addImageSignature

public final ImageMetadataSignature addImageSignature(int id,
                                                      Object value)
                                               throws Exception

Creates new ImageMetadataSignature with passed arguments and adds it to collection.

Parameters:

id - Unique identifier Image Metadata Signature name. See references for Exif tags specifications for possible id values

value - Metadata value

Returns:

Newly created signature that was added to MetadataSignatures collection

Throws:

Exception

addPdfSignature

public final PdfMetadataSignature addPdfSignature(String name,
                                                  Object value,
                                                  String tag)
                                           throws Exception

Creates new PdfMetadataSignature with passed arguments and adds it to collection.

Parameters:

name - Name of Metadata signature object

value - Value of Metadata signature

tag - Prefix tag of Metadata signature

Returns:

Newly created signature that was added to MetadataSignatures collection

Throws:

Exception

getDataEncryption

public final IDataEncryption getDataEncryption()

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

getSignatures

public final MetadataSignatureCollection getSignatures()

Gets or sets the Metadata of signature.

setDataEncryption

public final void setDataEncryption(IDataEncryption value)

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

setSignatures

public final void setSignatures(MetadataSignatureCollection value)

Gets or sets the Metadata of signature.

signature

public BaseSignature signature()

Specified by:

signature in class SignOptions

toString

public String toString()

Override string conversion.

Overrides:

toString in class SignOptions

Returns:

validate

public void validate()

Internal method to validate the options parameters.

Overrides:

validate in class SignOptions