com.groupdocs.signature.domain.signatures.metadata

Class MetadataSignatureCollection

java.lang.Object

com.groupdocs.signature.domain.signatures.metadata.MetadataSignatureCollection

All Implemented Interfaces:

Iterable<MetadataSignature>

public class MetadataSignatureCollection
extends Object
implements Iterable<MetadataSignature>

Collection of Metadata signature objects.

Constructor Summary

Constructors

Constructor and Description
MetadataSignatureCollection() Creates Collection of Metadata signature.

Method Summary

Modifier and Type	Method and Description
void	add(MetadataSignature signature) Add Metadata Signature object to collection.
void	addRange(MetadataSignature[] signatures) Add Metadata Signature collection.
void	clear() Removes all items from the collection.
boolean	contains(String name) Returns true if a Metadata with the specified name exists in the collection.
Object	deepClone() Clone Metadata Signature Collection class with Metadata Signature Items.
int	getCount() Gets number of items in the collection.
protected List<MetadataSignature>	getItemsList() List of MetadataSignature.
protected Map<String,MetadataSignature>	getItemsMap() Dictionary of MetadataSignature with unique keys as Signature name.
int	indexOf(String name) Gets the index of a property by name.
boolean	remove(String name) Removes a Metadata Signature with the specified name from the collection.
boolean	removeAt(int index) Removes a Metadata Signature at the specified index.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

MetadataSignatureCollection

public MetadataSignatureCollection()

Creates Collection of Metadata signature.

Method Detail

add

public final void add(MetadataSignature signature)

Add Metadata Signature object to collection.

Parameters:

signature - Metadata signature to be added to collection.

Throws an exception if name value is not unique entire existing collection

addRange

public final void addRange(MetadataSignature[] signatures)
                    throws Exception

Add Metadata Signature collection.

Parameters:

signatures - Collection of signatures to add.

Throws an exception if name value is not unique entire existing collection

Throws:

Exception

clear

public final void clear()

Removes all items from the collection.

contains

public final boolean contains(String name)

Returns true if a Metadata with the specified name exists in the collection.

Parameters:

name - The case-insensitive name of the property.

Returns:

True if the Metadata exists in the collection; false otherwise.

deepClone

public final Object deepClone()
                       throws Exception

Clone Metadata Signature Collection class with Metadata Signature Items.

Returns:

Returns copied instance with cloned Signature Items

Throws:

Exception

getCount

public final int getCount()

Gets number of items in the collection.

getItemsList

protected final List<MetadataSignature> getItemsList()

List of MetadataSignature.

getItemsMap

protected final Map<String,MetadataSignature> getItemsMap()

Dictionary of MetadataSignature with unique keys as Signature name.

indexOf

public final int indexOf(String name)

Gets the index of a property by name.

Parameters:

name - The case-insensitive name of the MetadataSignature.

Returns:

The zero based index. Negative value if not found.

remove

public final boolean remove(String name)

Removes a Metadata Signature with the specified name from the collection.

Parameters:

name - The case-insensitive name of the Metadata Signature.

Returns:

removeAt

public final boolean removeAt(int index)

Removes a Metadata Signature at the specified index.

Parameters:

index - The zero based index.