eu.id3.document

Class PointList

java.lang.Object

eu.id3.document.PointList

All Implemented Interfaces:

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

public class PointList
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable, java.lang.Iterable<Point>

Represents a point list.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

PointList

public PointList()
          throws DocumentException

Creates a new instance of the PointList class.

Throws:

DocumentException - An error has occurred during Document Library execution.

PointList

public PointList(long handle)
          throws DocumentException

Creates a new instance of the PointList class.

Parameters:

handle - Handle to the PointList.

Throws:

DocumentException - An error has occurred during Document Library execution.

Method Detail

close

public void close()

Releases all resources used by this PointList.

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 PointList clone()
                throws DocumentException

Creates a copy of the PointList object.

Overrides:

clone in class java.lang.Object

Returns:

The newly created PointList object.

Throws:

DocumentException - An error has occurred during Document Library execution.

clear

public void clear()
           throws DocumentException

Clears the PointList object.

Throws:

DocumentException - An error has occurred during Document Library execution.

add

public void add(Point pointItem)
         throws DocumentException

Adds an item to the PointList object.

Parameters:

pointItem - Point item to add.

Throws:

DocumentException - An error has occurred during Document Library execution.

get

public Point get(int index)
          throws DocumentException

Gets an item of the PointList object.

Parameters:

index - Index of the Point item to get.

Returns:

Point item to get.

Throws:

DocumentException - An error has occurred during Document Library execution.

set

public void set(int index,
                Point pointItem)
         throws DocumentException

Sets an item of the PointList object.

Parameters:

index - Index of the Point item to set.

pointItem - Point item to set.

Throws:

DocumentException - An error has occurred during Document Library execution.

getCount

public int getCount()
             throws DocumentException

Gets the number of elements in the PointList object.

Returns:

Number of elements in the Point object.

Throws:

DocumentException - An error has occurred during Document Library execution.

removeAt

public void removeAt(int index)
              throws DocumentException

Removes an element of the PointList object.

Parameters:

index - Index of the Point item to remove.

Throws:

DocumentException - An error has occurred during Document Library execution.

resize

public void resize(int newSize)
            throws DocumentException

PointList object.

Parameters:

newSize - Point object.

Throws:

DocumentException - An error has occurred during Document Library execution.

iterator

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

Specified by:

iterator in interface java.lang.Iterable<Point>