eu.id3.face

Class ImageList

java.lang.Object

eu.id3.face.ImageList

All Implemented Interfaces:

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

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

Represents a list of images.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

ImageList

public ImageList()
          throws FaceException

Creates a new instance of the ImageList class.

Throws:

FaceException - An error has occurred during Face Library execution.

ImageList

public ImageList(long handle)
          throws FaceException

Creates a new instance of the ImageList class.

Parameters:

handle - Handle to the ImageList.

Throws:

FaceException - An error has occurred during Face Library execution.

Method Detail

close

public void close()

Releases all resources used by this ImageList.

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

Creates a copy of the ImageList object.

Overrides:

clone in class java.lang.Object

Returns:

The newly created ImageList object.

Throws:

FaceException - An error has occurred during Face Library execution.

clear

public void clear()
           throws FaceException

Clears the ImageList object.

Throws:

FaceException - An error has occurred during Face Library execution.

add

public void add(Image imageItem)
         throws FaceException

Adds an item to the ImageList object.

Parameters:

imageItem - Image item to add.

Throws:

FaceException - An error has occurred during Face Library execution.

get

public Image get(int index)
          throws FaceException

Gets an item of the ImageList object.

Parameters:

index - Index 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(int index,
                Image imageItem)
         throws FaceException

Sets an item of the ImageList object.

Parameters:

index - Index 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 ImageList object.

Returns:

Number of elements in the Image object.

Throws:

FaceException - An error has occurred during Face Library execution.

removeAt

public void removeAt(int index)
              throws FaceException

Removes an element of the ImageList object.

Parameters:

index - Index of the Image item to remove.

Throws:

FaceException - An error has occurred during Face Library execution.

resize

public void resize(int newSize)
            throws FaceException

ImageList object.

Parameters:

newSize - Image object.

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>