com.sun.javafx.collections

Class MappingChange<E,F>

java.lang.Object

javafx.collections.ListChangeListener.Change<F>

com.sun.javafx.collections.MappingChange<E,F>

public final class MappingChange<E,F>
extends ListChangeListener.Change<F>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MappingChange.Map<E,F>

Field Summary

Fields

Modifier and Type	Field and Description
private MappingChange.Map<E,F>	map
static MappingChange.Map	NOOP_MAP
private ListChangeListener.Change<? extends E>	original
private java.util.List<F>	removed

Constructor Summary

Constructors

Constructor and Description
MappingChange(ListChangeListener.Change<? extends E> original, MappingChange.Map<E,F> map, ObservableList<F> list)

Method Summary

Modifier and Type	Method and Description
int	getFrom() If wasAdded is true, the interval contains all the values that were added.
protected int[]	getPermutation() If this change is an permutation, it returns an integer array that describes the permutation.
int	getPermutation(int i) By calling these method, you can observe the permutation that happened.
java.util.List<F>	getRemoved() An immutable list of removed/replaced elements.
int	getTo() The end of the change interval.
boolean	next() Go to the next change.
void	reset() Reset to the initial stage.
java.lang.String	toString()
boolean	wasPermutated() Indicates if the change was only a permutation.
boolean	wasUpdated() Indicates that the elements between getFrom() (inclusive) to getTo() exclusive has changed.

Methods inherited from class javafx.collections.ListChangeListener.Change

getAddedSize, getAddedSubList, getList, getRemovedSize, wasAdded, wasRemoved, wasReplaced

Methods inherited from class java.lang.Object

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

Field Detail

map

private final MappingChange.Map<E,F> map

original

private final ListChangeListener.Change<? extends E> original

removed

private java.util.List<F> removed

NOOP_MAP

public static final MappingChange.Map NOOP_MAP

Constructor Detail

MappingChange

public MappingChange(ListChangeListener.Change<? extends E> original,
                     MappingChange.Map<E,F> map,
                     ObservableList<F> list)

Method Detail

next

public boolean next()

Description copied from class: ListChangeListener.Change

Go to the next change. The Change in the initial state is invalid a requires a call to next() before calling other methods. The first next() call will make this object represent the first change.

Specified by:

next in class ListChangeListener.Change<F>

Returns:

true if switched to the next change, false if this is the last change.

reset

public void reset()

Description copied from class: ListChangeListener.Change

Reset to the initial stage. After this call, the next() must be called before working with the first change.

Specified by:

reset in class ListChangeListener.Change<F>

getFrom

public int getFrom()

Description copied from class: ListChangeListener.Change

If wasAdded is true, the interval contains all the values that were added. If wasPermutated is true, the interval marks the values that were permutated. If wasRemoved is true and wasAdded is false, getFrom() and getTo() should return the same number - the place where the removed elements were positioned in the list.

Specified by:

getFrom in class ListChangeListener.Change<F>

Returns:

a beginning (inclusive) of an interval related to the change

getTo

public int getTo()

Description copied from class: ListChangeListener.Change

The end of the change interval.

Specified by:

getTo in class ListChangeListener.Change<F>

Returns:

a end (exclusive) of an interval related to the change.

See Also:

ListChangeListener.Change.getFrom()

getRemoved

public java.util.List<F> getRemoved()

Description copied from class: ListChangeListener.Change

An immutable list of removed/replaced elements. If no elements were removed from the list, an empty list is returned.

Specified by:

getRemoved in class ListChangeListener.Change<F>

Returns:

a list with all the removed elements

getPermutation

protected int[] getPermutation()

Description copied from class: ListChangeListener.Change

If this change is an permutation, it returns an integer array that describes the permutation. This array maps directly from the previous indexes to the new ones. This method is not publicly accessible and therefore can return an array safely. The 0 index of the array corresponds to index ListChangeListener.Change.getFrom() of the list. The same applies for the last index and ListChangeListener.Change.getTo(). The method is used by ListChangeListener.Change.wasPermutated() and ListChangeListener.Change.getPermutation(int) methods.

Specified by:

getPermutation in class ListChangeListener.Change<F>

Returns:

empty array if this is not permutation or an integer array containing the permutation

wasPermutated

public boolean wasPermutated()

Description copied from class: ListChangeListener.Change

Indicates if the change was only a permutation.

Overrides:

wasPermutated in class ListChangeListener.Change<F>

Returns:

true if the change was just a permutation.

wasUpdated

public boolean wasUpdated()

Description copied from class: ListChangeListener.Change

Indicates that the elements between getFrom() (inclusive) to getTo() exclusive has changed. This is the only optional event type and may not be fired by all ObservableLists.

Overrides:

wasUpdated in class ListChangeListener.Change<F>

Returns:

true if the current change is an update change.

getPermutation

public int getPermutation(int i)

Description copied from class: ListChangeListener.Change

By calling these method, you can observe the permutation that happened. In order to get the new position of an element, you must call:

    change.getPermutation(oldIndex);
 

Note: default implementation of this method takes the information from ListChangeListener.Change.getPermutation() method. You don't have to override this method.

Overrides:

getPermutation in class ListChangeListener.Change<F>

Parameters:

i - the old index that contained the element prior to this change

Returns:

the new index of the same element

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object