javafx.collections.ObservableArray Maven / Gradle / Ivy
Show all versions of openjfx-78-backport Show documentation
/*
* Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javafx.collections;
import javafx.beans.Observable;
/**
* {@code ObservableArray} is an array that allows listeners to track changes
* when they occur. In order to track changes, the internal array
* is encapsulated and there is no direct access available from the outside.
* Bulk operations are supported but they always do a copy of the data range.
* You can find them in subclasses as they deal with primitive arrays directly.
*
* Implementations have both {@code capacity}, which is internal array length,
* and {@code size}. If size needs to be increased beyond capacity, the capacity
* increases to match that new size. Use {@link #trimToSize()} method
* to shrink it.
*
* @see ArrayChangeListener
* @param actual array instance type
* @since JavaFX 8.0
*/
public interface ObservableArray> extends Observable {
/**
* Add a listener to this observable array.
* @param listener the listener for listening to the array changes
* @throws NullPointerException if {@code listener} is {@code null}
*/
public void addListener(ArrayChangeListener listener);
/**
* Tries to remove a listener from this observable array. If the listener is not
* attached to this array, nothing happens.
* @param listener a listener to remove
* @throws NullPointerException if {@code listener} is {@code null}
*/
public void removeListener(ArrayChangeListener listener);
/**
* Sets new length of data in this array. This method grows capacity
* if necessary but never shrinks it. Resulting array will contain existing
* data for indexes that are less than the current size and zeroes for
* indexes that are greater than the current size.
* @param size new length of data in this array
* @throws NegativeArraySizeException if size is negative
*/
public void resize(int size);
/**
* Grows the capacity of this array if the current capacity is less than
* given {@code capacity}, does nothing if it already exceeds
* the {@code capacity}.
* @param capacity
*/
public void ensureCapacity(int capacity);
/**
* Shrinks the capacity to the current size of data in the array.
*/
public void trimToSize();
/**
* Empties the array by resizing it to 0. Capacity is not changed.
* @see #trimToSize()
*/
public void clear();
/**
* Retrieves length of data in this array.
* @return length of data in this array
*/
public int size();
}