eu.id3.face

Class FaceCandidateList

java.lang.Object

eu.id3.face.FaceCandidateList

All Implemented Interfaces:

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

public class FaceCandidateList
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable, java.lang.Iterable<FaceCandidate>

Represents a candidate list in a one-to-many search.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	add(FaceCandidate faceCandidateItem) Adds an item to the FaceCandidateList object.
void	clear() Clears the FaceCandidateList object.
FaceCandidateList	clone() Creates a copy of the FaceCandidateList object.
void	close() Releases all resources used by this FaceCandidateList.
protected void	finalize() Finalizer for this class.
FaceCandidate	get(int index) Gets an item of the FaceCandidateList object.
int	getCount() Gets the number of elements in the FaceCandidateList object.
long	getHandle() Gets the native handle.
java.util.Iterator<FaceCandidate>	iterator()
void	removeAt(int index) Removes an element of the FaceCandidateList object.
void	resize(int newSize) FaceCandidateList object.
void	set(int index, FaceCandidate faceCandidateItem) Sets an item of the FaceCandidateList 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

FaceCandidateList

public FaceCandidateList()
                  throws FaceException

Creates a new instance of the FaceCandidateList class.

Throws:

FaceException - An error has occurred during Face Library execution.

FaceCandidateList

public FaceCandidateList(long handle)
                  throws FaceException

Creates a new instance of the FaceCandidateList class.

Parameters:

handle - Handle to the FaceCandidateList.

Throws:

FaceException - An error has occurred during Face Library execution.

Method Detail

close

public void close()

Releases all resources used by this FaceCandidateList.

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

Creates a copy of the FaceCandidateList object.

Overrides:

clone in class java.lang.Object

Returns:

The newly created FaceCandidateList object.

Throws:

FaceException - An error has occurred during Face Library execution.

clear

public void clear()
           throws FaceException

Clears the FaceCandidateList object.

Throws:

FaceException - An error has occurred during Face Library execution.

add

public void add(FaceCandidate faceCandidateItem)
         throws FaceException

Adds an item to the FaceCandidateList object.

Parameters:

faceCandidateItem - FaceCandidate item to add.

Throws:

FaceException - An error has occurred during Face Library execution.

get

public FaceCandidate get(int index)
                  throws FaceException

Gets an item of the FaceCandidateList object.

Parameters:

index - Index of the FaceCandidate item to get.

Returns:

FaceCandidate item to get.

Throws:

FaceException - An error has occurred during Face Library execution.

set

public void set(int index,
                FaceCandidate faceCandidateItem)
         throws FaceException

Sets an item of the FaceCandidateList object.

Parameters:

index - Index of the FaceCandidate item to set.

faceCandidateItem - FaceCandidate 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 FaceCandidateList object.

Returns:

Number of elements in the FaceCandidate object.

Throws:

FaceException - An error has occurred during Face Library execution.

removeAt

public void removeAt(int index)
              throws FaceException

Removes an element of the FaceCandidateList object.

Parameters:

index - Index of the FaceCandidate item to remove.

Throws:

FaceException - An error has occurred during Face Library execution.

resize

public void resize(int newSize)
            throws FaceException

FaceCandidateList object.

Parameters:

newSize - FaceCandidate object.

Throws:

FaceException - An error has occurred during Face Library execution.

iterator

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

Specified by:

iterator in interface java.lang.Iterable<FaceCandidate>