javafx.collections

Interface ObservableIntegerArray

All Superinterfaces:

Observable, ObservableArray<ObservableIntegerArray>

public interface ObservableIntegerArray
extends ObservableArray<ObservableIntegerArray>

An int[] 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.

See Also:

ArrayChangeListener

Method Summary

Modifier and Type	Method and Description
void	addAll(int... elements) Appends given elements to the end of array.
void	addAll(int[] src, int srcIndex, int length)
void	addAll(ObservableIntegerArray src)
void	addAll(ObservableIntegerArray src, int srcIndex, int length)
void	copyTo(int srcIndex, int[] dest, int destIndex, int length) Copies specified portion of array into dest array.
void	copyTo(int srcIndex, ObservableIntegerArray dest, int destIndex, int length)
int	get(int index) Gets a single value of array.
void	set(int index, int value) Sets a single value in the array.
void	set(int destIndex, int[] src, int srcIndex, int length) Sets portion of observable array to a copy of given array.
void	set(int destIndex, ObservableIntegerArray src, int srcIndex, int length)
void	setAll(int... elements) Sets observable array to a copy of given array.
void	setAll(int[] src, int srcIndex, int length)
void	setAll(ObservableIntegerArray src)
void	setAll(ObservableIntegerArray src, int srcIndex, int length)
int[]	toArray(int[] dest) Returns an array containing copy of the observable array.
int[]	toArray(int srcIndex, int[] dest, int length) Returns an array containing copy of specified portion of the observable array.

Methods inherited from interface javafx.collections.ObservableArray

addListener, clear, ensureCapacity, removeListener, resize, size, trimToSize

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Method Detail

copyTo

void copyTo(int srcIndex,
            int[] dest,
            int destIndex,
            int length)

Copies specified portion of array into dest array. Throws the same exceptions as System.arraycopy(java.lang.Object, int, java.lang.Object, int, int)

Parameters:

srcIndex - starting position in the observable array

dest - destination array

destIndex - starting position in destination array

length - length of portion to copy

copyTo

void copyTo(int srcIndex,
            ObservableIntegerArray dest,
            int destIndex,
            int length)

get

int get(int index)

Gets a single value of array. This is generally as fast as direct access to an array and eliminates necessity to make a copy of array.

Parameters:

index - index of element to get

Returns:

value at the given index

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index is outside array bounds

addAll

void addAll(int... elements)

Appends given elements to the end of array. Capacity is increased if necessary to match the new size of the data.

Parameters:

elements -

addAll

void addAll(ObservableIntegerArray src)

addAll

void addAll(int[] src,
            int srcIndex,
            int length)

addAll

void addAll(ObservableIntegerArray src,
            int srcIndex,
            int length)

setAll

void setAll(int... elements)

Sets observable array to a copy of given array. Capacity is increased if necessary to match the new size of the data

Parameters:

elements - source array to copy.

Throws:

java.lang.NullPointerException - if array is null

setAll

void setAll(int[] src,
            int srcIndex,
            int length)

setAll

void setAll(ObservableIntegerArray src)

setAll

void setAll(ObservableIntegerArray src,
            int srcIndex,
            int length)

set

void set(int destIndex,
         int[] src,
         int srcIndex,
         int length)

Sets portion of observable array to a copy of given array. Throws the same exceptions as System.arraycopy(java.lang.Object, int, java.lang.Object, int, int)

Parameters:

destIndex - the starting destination index in this observable array

src - source array to copy

srcIndex - starting position in source array

length - length of portion to copy

set

void set(int destIndex,
         ObservableIntegerArray src,
         int srcIndex,
         int length)

set

void set(int index,
         int value)

Sets a single value in the array. Avoid using this method if many values are updated, use #setAll(int, int[], int, int) update method instead with as minimum number of invocations as possible.

Parameters:

index - index of the value to setAll

value - new value for the given index

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index is outside array bounds

toArray

int[] toArray(int[] dest)

Returns an array containing copy of the observable array. If the observable array fits in the specified array, it is copied therein. Otherwise, a new array is allocated with the size of the observable array.

Parameters:

dest - the array into which the observable array to be copied, if it is big enough; otherwise, a new int array is allocated. Ignored, if null.

Returns:

an int array containing the copy of the observable array

toArray

int[] toArray(int srcIndex,
              int[] dest,
              int length)

Returns an array containing copy of specified portion of the observable array. If specified portion of the observable array fits in the specified array, it is copied therein. Otherwise, a new array of given length is allocated.

Parameters:

srcIndex - starting position in the observable array

dest - the array into which specified portion of the observable array to be copied, if it is big enough; otherwise, a new int array is allocated. Ignored, if null.

length - length of portion to copy

Returns:

an int array containing the copy of specified portion the observable array