eu.id3.document

Class StringDict

java.lang.Object

eu.id3.document.StringDict

All Implemented Interfaces:

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

public class StringDict
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable, java.lang.Iterable<java.lang.String>

Represents a string dictionary.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

StringDict

public StringDict()
           throws DocumentException

Creates a new instance of the StringDict class.

Throws:

DocumentException - An error has occurred during Document Library execution.

StringDict

public StringDict(long handle)
           throws DocumentException

Creates a new instance of the StringDict class.

Parameters:

handle - Handle to the StringDict.

Throws:

DocumentException - An error has occurred during Document Library execution.

Method Detail

close

public void close()

Releases all resources used by this StringDict.

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 StringDict clone()
                 throws DocumentException

Creates a copy of the StringDict object.

Overrides:

clone in class java.lang.Object

Returns:

The newly created StringDict 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 StringDict object.

Throws:

DocumentException - An error has occurred during Document Library execution.

add

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

Adds an item to the StringDict object.

Parameters:

key - Unique key of the item to add.

item - item to add.

Throws:

DocumentException - An error has occurred during Document Library execution.

get

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

Gets an item of the StringDict object.

Parameters:

key - Unique key of the item to get.

Returns:

item to get.

Throws:

DocumentException - An error has occurred during Document Library execution.

set

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

Sets an item of the StringDict object.

Parameters:

key - Unique key of the item to set.

item - 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 StringDict object.

Returns:

Number of elements in the object.

Throws:

DocumentException - An error has occurred during Document Library execution.

containsKey

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

Determines whether the StringDictobject contains the specified key.

Parameters:

key - The key to locate in the object.

Returns:

true if the 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 StringDict object.

Parameters:

key - Unique key of the item to remove.

Throws:

DocumentException - An error has occurred during Document Library execution.

iterator

public java.util.Iterator<java.lang.String> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>