eu.id3.face

Class ImageDict

java.lang.Object

eu.id3.face.ImageDict

All Implemented Interfaces:

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

public class ImageDict
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable, java.lang.Iterable<Image>

This class represents a ImageDict

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

ImageDict

public ImageDict()
          throws FaceException

Creates a new instance of the ImageDict class.

Throws:

FaceException - An error has occurred during Face Library execution.

ImageDict

public ImageDict(long handle)
          throws FaceException

Creates a new instance of the ImageDict class.

Parameters:

handle - Handle to the ImageDict.

Throws:

FaceException - An error has occurred during Face Library execution.

Method Detail

close

public void close()

Releases all resources used by this ImageDict.

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 ImageDict clone()
                throws FaceException

Creates a copy of the ImageDict object.

Overrides:

clone in class java.lang.Object

Returns:

The newly created ImageDict object.

Throws:

FaceException - An error has occurred during Face Library execution.

getKeys

public StringList getKeys()
                   throws FaceException

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

Returns:

Gets a string list containing the keys in the dict.

Throws:

FaceException - An error has occurred during Face Library execution.

clear

public void clear()
           throws FaceException

Clears the ImageDict object.

Throws:

FaceException - An error has occurred during Face Library execution.

add

public void add(java.lang.String key,
                Image imageItem)
         throws FaceException

Adds an item to the ImageDict object.

Parameters:

key - Unique key of the Image item to add.

imageItem - Image item to add.

Throws:

FaceException - An error has occurred during Face Library execution.

get

public Image get(java.lang.String key)
          throws FaceException

Gets an item of the ImageDict object.

Parameters:

key - Unique key of the Image item to get.

Returns:

Image item to get.

Throws:

FaceException - An error has occurred during Face Library execution.

set

public void set(java.lang.String key,
                Image imageItem)
         throws FaceException

Sets an item of the ImageDict object.

Parameters:

key - Unique key of the Image item to set.

imageItem - Image item to set.

Throws:

FaceException - An error has occurred during Face Library execution.

getCount

public int getCount()
             throws FaceException

Gets the number of elements in the ImageDict object.

Returns:

Number of elements in the Image object.

Throws:

FaceException - An error has occurred during Face Library execution.

containsKey

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

Determines whether the ImageDictobject contains the specified key.

Parameters:

key - The key to locate in the Image object.

Returns:

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

Throws:

FaceException - An error has occurred during Face Library execution.

remove

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

Removes an element of the ImageDict object.

Parameters:

key - Unique key of the Image item to remove.

Throws:

FaceException - An error has occurred during Face Library execution.

iterator

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

Specified by:

iterator in interface java.lang.Iterable<Image>