eu.id3.face

Class FaceTemplateDict

java.lang.Object

eu.id3.face.FaceTemplateDict

All Implemented Interfaces:

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

public class FaceTemplateDict
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable, java.lang.Iterable<FaceTemplate>

Represents a dictionary of face templates.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

FaceTemplateDict

public FaceTemplateDict()
                 throws FaceException

Creates a new instance of the FaceTemplateDict class.

Throws:

FaceException - An error has occurred during Face Library execution.

FaceTemplateDict

public FaceTemplateDict(long handle)
                 throws FaceException

Creates a new instance of the FaceTemplateDict class.

Parameters:

handle - Handle to the FaceTemplateDict.

Throws:

FaceException - An error has occurred during Face Library execution.

Method Detail

close

public void close()

Releases all resources used by this FaceTemplateDict.

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

Creates a copy of the FaceTemplateDict object.

Overrides:

clone in class java.lang.Object

Returns:

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

Throws:

FaceException - An error has occurred during Face Library execution.

add

public void add(java.lang.String key,
                FaceTemplate faceTemplateItem)
         throws FaceException

Adds an item to the FaceTemplateDict object.

Parameters:

key - Unique key of the FaceTemplate item to add.

faceTemplateItem - FaceTemplate item to add.

Throws:

FaceException - An error has occurred during Face Library execution.

get

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

Gets an item of the FaceTemplateDict object.

Parameters:

key - Unique key of the FaceTemplate item to get.

Returns:

FaceTemplate item to get.

Throws:

FaceException - An error has occurred during Face Library execution.

set

public void set(java.lang.String key,
                FaceTemplate faceTemplateItem)
         throws FaceException

Sets an item of the FaceTemplateDict object.

Parameters:

key - Unique key of the FaceTemplate item to set.

faceTemplateItem - FaceTemplate 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 FaceTemplateDict object.

Returns:

Number of elements in the FaceTemplate object.

Throws:

FaceException - An error has occurred during Face Library execution.

containsKey

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

Determines whether the FaceTemplateDictobject contains the specified key.

Parameters:

key - The key to locate in the FaceTemplate object.

Returns:

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

Parameters:

key - Unique key of the FaceTemplate item to remove.

Throws:

FaceException - An error has occurred during Face Library execution.

iterator

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

Specified by:

iterator in interface java.lang.Iterable<FaceTemplate>