eu.id3.document

Class DocumentInfoDictionary

java.lang.Object

eu.id3.document.DocumentInfoDictionary

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable, java.lang.Iterable<DocumentInfo>

public class DocumentInfoDictionary
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable, java.lang.Iterable<DocumentInfo>

Represents a dictionary of document information.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentInfoDictionary() Creates a new instance of the DocumentInfoDictionary class.
DocumentInfoDictionary(long handle) Creates a new instance of the DocumentInfoDictionary class.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String key, DocumentInfo documentInfoItem) Adds an item to the DocumentInfoDictionary object.
void	clear() Clears the DocumentInfoDictionary object.
DocumentInfoDictionary	clone() Creates a copy of the DocumentInfoDictionary object.
void	close() Releases all resources used by this DocumentInfoDictionary.
boolean	containsKey(java.lang.String key) Determines whether the DocumentInfoDictionaryobject contains the specified key.
protected void	finalize() Finalizer for this class.
DocumentInfo	get(java.lang.String key) Gets an item of the DocumentInfoDictionary object.
int	getCount() Gets the number of elements in the DocumentInfoDictionary object.
long	getHandle() Gets the native handle.
StringList	getKeys() Gets the gets a string list containing the keys in the dict.
java.util.Iterator<DocumentInfo>	iterator()
void	remove(java.lang.String key) Removes an element of the DocumentInfoDictionary object.
void	set(java.lang.String key, DocumentInfo documentInfoItem) Sets an item of the DocumentInfoDictionary object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DocumentInfoDictionary

public DocumentInfoDictionary()
                       throws DocumentException

Creates a new instance of the DocumentInfoDictionary class.

Throws:

DocumentException - An error has occurred during Document Library execution.

DocumentInfoDictionary

public DocumentInfoDictionary(long handle)
                       throws DocumentException

Creates a new instance of the DocumentInfoDictionary class.

Parameters:

handle - Handle to the DocumentInfoDictionary.

Throws:

DocumentException - An error has occurred during Document Library execution.

Method Detail

close

public void close()

Releases all resources used by this DocumentInfoDictionary.

Specified by:

close in interface java.lang.AutoCloseable

finalize

protected void finalize()

Finalizer for this class. Finalizers are deprecated since Java 9+. This method is not guaranteed to be called. To release all memory held by this class please be sure to call the close() method.

Overrides:

finalize in class java.lang.Object

getHandle

public long getHandle()

Gets the native handle.

Returns:

The native handle.

clone

public DocumentInfoDictionary clone()
                             throws DocumentException

Creates a copy of the DocumentInfoDictionary object.

Overrides:

clone in class java.lang.Object

Returns:

The newly created DocumentInfoDictionary object.

Throws:

DocumentException - An error has occurred during Document Library execution.

getKeys

public StringList getKeys()
                   throws DocumentException

Gets the gets a string list containing the keys in the dict.

Returns:

Gets a string list containing the keys in the dict.

Throws:

DocumentException - An error has occurred during Document Library execution.

clear

public void clear()
           throws DocumentException

Clears the DocumentInfoDictionary object.

Throws:

DocumentException - An error has occurred during Document Library execution.

add

public void add(java.lang.String key,
                DocumentInfo documentInfoItem)
         throws DocumentException

Adds an item to the DocumentInfoDictionary object.

Parameters:

key - Unique key of the DocumentInfo item to add.

documentInfoItem - DocumentInfo item to add.

Throws:

DocumentException - An error has occurred during Document Library execution.

get

public DocumentInfo get(java.lang.String key)
                 throws DocumentException

Gets an item of the DocumentInfoDictionary object.

Parameters:

key - Unique key of the DocumentInfo item to get.

Returns:

DocumentInfo item to get.

Throws:

DocumentException - An error has occurred during Document Library execution.

set

public void set(java.lang.String key,
                DocumentInfo documentInfoItem)
         throws DocumentException

Sets an item of the DocumentInfoDictionary object.

Parameters:

key - Unique key of the DocumentInfo item to set.

documentInfoItem - DocumentInfo item to set.

Throws:

DocumentException - An error has occurred during Document Library execution.

getCount

public int getCount()
             throws DocumentException

Gets the number of elements in the DocumentInfoDictionary object.

Returns:

Number of elements in the DocumentInfo object.

Throws:

DocumentException - An error has occurred during Document Library execution.

containsKey

public boolean containsKey(java.lang.String key)
                    throws DocumentException

Determines whether the DocumentInfoDictionaryobject contains the specified key.

Parameters:

key - The key to locate in the DocumentInfo object.

Returns:

true if the DocumentInfo object contains an element with the specified key, otherwise false.

Throws:

DocumentException - An error has occurred during Document Library execution.

remove

public void remove(java.lang.String key)
            throws DocumentException

Removes an element of the DocumentInfoDictionary object.

Parameters:

key - Unique key of the DocumentInfo item to remove.

Throws:

DocumentException - An error has occurred during Document Library execution.

iterator

public java.util.Iterator<DocumentInfo> iterator()

Specified by:

iterator in interface java.lang.Iterable<DocumentInfo>