eu.id3.face

Class StringList

java.lang.Object

eu.id3.face.StringList

All Implemented Interfaces:

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

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

Represents a list of strings.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String item) Adds an item to the StringList object.
void	clear() Clears the StringList object.
void	close() Releases all resources used by this StringList.
protected void	finalize() Finalizer for this class.
java.lang.String	get(int index) Gets an item of the StringList object.
int	getCount() Gets the number of elements in the StringList object.
long	getHandle() Gets the native handle.
java.util.Iterator<java.lang.String>	iterator()
void	removeAt(int index) Removes an element of the StringList object.
void	resize(int newSize) StringList object.
void	set(int index, java.lang.String item) Sets an item of the StringList object.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

StringList

public StringList()
           throws FaceException

Creates a new instance of the StringList class.

Throws:

FaceException - An error has occurred during Face Library execution.

StringList

public StringList(long handle)
           throws FaceException

Creates a new instance of the StringList class.

Parameters:

handle - Handle to the StringList.

Throws:

FaceException - An error has occurred during Face Library execution.

Method Detail

close

public void close()

Releases all resources used by this StringList.

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.

clear

public void clear()
           throws FaceException

Clears the StringList object.

Throws:

FaceException - An error has occurred during Face Library execution.

add

public void add(java.lang.String item)
         throws FaceException

Adds an item to the StringList object.

Parameters:

item - item to add.

Throws:

FaceException - An error has occurred during Face Library execution.

get

public java.lang.String get(int index)
                     throws FaceException

Gets an item of the StringList object.

Parameters:

index - Index of the item to get.

Returns:

item to get.

Throws:

FaceException - An error has occurred during Face Library execution.

set

public void set(int index,
                java.lang.String item)
         throws FaceException

Sets an item of the StringList object.

Parameters:

index - Index of the item to set.

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

Returns:

Number of elements in the object.

Throws:

FaceException - An error has occurred during Face Library execution.

removeAt

public void removeAt(int index)
              throws FaceException

Removes an element of the StringList object.

Parameters:

index - Index of the item to remove.

Throws:

FaceException - An error has occurred during Face Library execution.

resize

public void resize(int newSize)
            throws FaceException

StringList object.

Parameters:

newSize - object.

Throws:

FaceException - An error has occurred during Face Library execution.

iterator

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

Specified by:

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