javafx.collections

Interface ObservableArray<T extends ObservableArray<T>>

Type Parameters:

T - actual array instance type

All Superinterfaces:

Observable

All Known Subinterfaces:

ObservableFloatArray, ObservableIntegerArray

All Known Implementing Classes:

ObservableArrayBase

public interface ObservableArray<T extends ObservableArray<T>>
extends Observable

An array that allows listeners to track changes when they occur. To achieve that internal array is encapsulated and there is no direct access available from outside. Bulk operations are supported but they always do copy of the data range. You can find them in subclasses as they deal with primitive arrays directly. Implementations have both capacity which is internal array length and size. If size needs to be increased beyond capacity the capacity increases to match that new size. Use trimToSize() method to shrink it.

See Also:

ArrayChangeListener

Method Summary

Modifier and Type	Method and Description
void	addListener(ArrayChangeListener<T> listener) Add a listener to this observable array.
void	clear() Sets size of array to 0.
void	ensureCapacity(int capacity) Grows capacity if it is less then given value, does nothing if it already exceeds the value.
void	removeListener(ArrayChangeListener<T> listener) Tries to removed a listener from this observable array.
void	resize(int size) Sets new length of data in this array.
int	size() Retrieves length of data in this array.
void	trimToSize() Shrinks capacity to the current size of data in the array.

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Method Detail

addListener

void addListener(ArrayChangeListener<T> listener)

Add a listener to this observable array.

Parameters:

listener - the listener for listening to the array changes

removeListener

void removeListener(ArrayChangeListener<T> listener)

Tries to removed a listener from this observable array. If the listener is not attached to this array, nothing happens.

Parameters:

listener - a listener to remove

resize

void resize(int size)

Sets new length of data in this array. This method ensures capacity for the new array length but never shrinks it. To avoid data copying call clear() before setting it to new value. New elements will be set to 0.

ensureCapacity

void ensureCapacity(int capacity)

Grows capacity if it is less then given value, does nothing if it already exceeds the value.

Parameters:

capacity -

trimToSize

void trimToSize()

Shrinks capacity to the current size of data in the array.

clear

void clear()

Sets size of array to 0. No data removed nor capacity changes.

size

int size()

Retrieves length of data in this array.

Returns:

length of data in this array