ObservableList

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> progeeks >> [ util overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.progeeks.util.ObservableList

SOURCE |

Download org.progeeks.util.ObservableList

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.progeeks.util
Class ObservableList

java.lang.Object
  org.progeeks.util.ObservableList

All Implemented Interfaces:: java.util.Collection, java.lang.Iterable, java.util.List, java.io.Serializable

public class ObservableList
extends java.lang.Object
implements java.util.List, java.io.Serializable

A java.util.List wrapper that will deliver the appropriate ListPropertyChangeEvents when the list is modified.

Version:: $Revision: 1.5 $

Nested Class Summary

private class ObservableList.ObservableIterator
          Iterator class that makes sure to take care of notifications.

private class ObservableList.ObservableListIterator
          List iterator class that makes sure to take care of notifications.

Field Summary

private java.util.List list


private java.util.List listeners


Constructor Summary

ObservableList(java.util.List list)


Method Summary

void add(int index, java.lang.Object element)
          Insert an element into the list at a given position (optional operation).

boolean add(java.lang.Object o)
          Add an element to the end of the list (optional operation).

boolean addAll(java.util.Collection c)
          Add the contents of a collection to the end of the list (optional operation).

boolean addAll(int index, java.util.Collection c)
          Insert the contents of a collection into the list at a given position (optional operation).

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)


void clear()
          Clear the list, such that a subsequent call to isEmpty() would return true (optional operation).

boolean contains(java.lang.Object o)
          Test whether this list contains a given object as one of its elements.

boolean containsAll(java.util.Collection c)
          Test whether this list contains every element in a given collection.

boolean equals(java.lang.Object o)
          Test whether this list is equal to another object.

void fireElementsInserted(int first, int last)
          Sends an event to interested listeners that this property has had elements inserted.

void fireElementsModified(int first, int last)
          Sends an event to interested listeners that this property has had elements inserted.

void fireElementsRemoved(int first, int last)
          Sends an event to interested listeners that this property has had elements inserted.

protected void firePropertyChangeEvent(java.beans.PropertyChangeEvent event)
          Implemented by subclasses to deliver a change event to the appropriately registered listeners.

java.lang.Object get(int index)
          Get the element at a given index in this list.

protected java.lang.String getPropertyName()


int hashCode()
          Obtains a hash code for this list.

int indexOf(java.lang.Object o)
          Obtain the first index at which a given object is to be found in this list.

boolean isEmpty()
          Test whether this list is empty, that is, if size() == 0.

java.util.Iterator iterator()
          Obtain an Iterator over this list, whose sequence is the list order.

int lastIndexOf(java.lang.Object o)
          Obtain the last index at which a given object is to be found in this list.

java.util.ListIterator listIterator()
          Obtain a ListIterator over this list, starting at the beginning.

java.util.ListIterator listIterator(int index)
          Obtain a ListIterator over this list, starting at a given position.

java.lang.Object remove(int index)
          Remove the element at a given position in this list (optional operation).

boolean remove(java.lang.Object o)
          Remove the first occurence of an object from this list (optional operation).

boolean removeAll(java.util.Collection c)
          Remove all elements of a given collection from this list (optional operation).

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)


boolean retainAll(java.util.Collection c)
          Remove all elements of this list that are not contained in a given collection (optional operation).

java.lang.Object set(int index, java.lang.Object element)
          Replace an element of this list with another object (optional operation).

int size()
          Get the number of elements in this list.

java.util.List subList(int from, int to)
          Obtain a List view of a subsection of this list, from fromIndex (inclusive) to toIndex (exclusive).

java.lang.Object[] toArray()
          Copy the current contents of this list into an array.

java.lang.Object[] toArray(java.lang.Object[] a)
          Copy the current contents of this list into an array.

java.lang.String toString()
          Convert this Object to a human-readable String.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

list

private java.util.List list

listeners

private transient java.util.List listeners

Constructor Detail

ObservableList

public ObservableList(java.util.List list)

Method Detail

size

public int size()

Description copied from interface: java.util.List

Get the number of elements in this list. If the list contains more than Integer.MAX_VALUE elements, return Integer.MAX_VALUE.

Specified by:: size in interface java.util.List

isEmpty

public boolean isEmpty()

Description copied from interface: java.util.List

Test whether this list is empty, that is, if size() == 0.

Specified by:: isEmpty in interface java.util.List

contains

public boolean contains(java.lang.Object o)

Description copied from interface: java.util.List

Test whether this list contains a given object as one of its elements. This is defined as the existence of an element e such that o == null ? e == null : o.equals(e).

Specified by:: contains in interface java.util.List

iterator

public java.util.Iterator iterator()

Description copied from interface: java.util.List

Obtain an Iterator over this list, whose sequence is the list order.

Specified by:: iterator in interface java.util.List

toArray

public java.lang.Object[] toArray()

Description copied from interface: java.util.List

Copy the current contents of this list into an array.

Specified by:: toArray in interface java.util.List

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)

Description copied from interface: java.util.List

Copy the current contents of this list into an array. If the array passed as an argument has length less than that of this list, an array of the same run-time type as a, and length equal to the length of this list, is allocated using Reflection. Otherwise, a itself is used. The elements of this list are copied into it, and if there is space in the array, the following element is set to null. The resultant array is returned. Note: The fact that the following element is set to null is only useful if it is known that this list does not contain any null elements.

Specified by:: toArray in interface java.util.List

add

public boolean add(java.lang.Object o)

Description copied from interface: java.util.List

Add an element to the end of the list (optional operation). If the list imposes restraints on what can be inserted, such as no null elements, this should be documented.

Specified by:: add in interface java.util.List

remove

public boolean remove(java.lang.Object o)

Description copied from interface: java.util.List

Remove the first occurence of an object from this list (optional operation). That is, remove the first element e such that o == null ? e == null : o.equals(e).

Specified by:: remove in interface java.util.List

containsAll

public boolean containsAll(java.util.Collection c)

Description copied from interface: java.util.List

Test whether this list contains every element in a given collection.

Specified by:: containsAll in interface java.util.List

addAll

public boolean addAll(java.util.Collection c)

Description copied from interface: java.util.List

Add the contents of a collection to the end of the list (optional operation). This operation is undefined if this list is modified during the operation (for example, if you try to insert a list into itself).

Specified by:: addAll in interface java.util.List

addAll

public boolean addAll(int index,
                      java.util.Collection c)

Description copied from interface: java.util.List

Insert the contents of a collection into the list at a given position (optional operation). Shift all elements at that position to the right by the number of elements inserted. This operation is undefined if this list is modified during the operation (for example, if you try to insert a list into itself).

Specified by:: addAll in interface java.util.List

removeAll

public boolean removeAll(java.util.Collection c)

Description copied from interface: java.util.List

Remove all elements of a given collection from this list (optional operation). That is, remove every element e such that c.contains(e).

Specified by:: removeAll in interface java.util.List

retainAll

public boolean retainAll(java.util.Collection c)

Description copied from interface: java.util.List

Remove all elements of this list that are not contained in a given collection (optional operation). That is, remove every element e such that !c.contains(e).

Specified by:: retainAll in interface java.util.List

clear

public void clear()

Description copied from interface: java.util.List

Clear the list, such that a subsequent call to isEmpty() would return true (optional operation).

Specified by:: clear in interface java.util.List

equals

public boolean equals(java.lang.Object o)

Description copied from interface: java.util.List

Test whether this list is equal to another object. A List is defined to be equal to an object if and only if that object is also a List, and the two lists have the same sequence. Two lists l1 and l2 are equal if and only if l1.size() == l2.size(), and for every integer n between 0 and l1.size() - 1 inclusive,

l1.get(n) == null ?
 l2.get(n) == null : l1.get(n).equals(l2.get(n))

Specified by:: equals in interface java.util.List

hashCode

public int hashCode()

Description copied from interface: java.util.List

Obtains a hash code for this list. In order to obey the general contract of the hashCode method of class Object, this value is calculated as follows:

hashCode = 1;
Iterator i = list.iterator();
while (i.hasNext())
{
  Object obj = i.next();
  hashCode = 31 * hashCode + (obj == null ? 0 : obj.hashCode());
}

This ensures that the general contract of Object.hashCode() is adhered to.

Specified by:: hashCode in interface java.util.List

get

public java.lang.Object get(int index)

Description copied from interface: java.util.List

Get the element at a given index in this list.

Specified by:: get in interface java.util.List

set

public java.lang.Object set(int index,
                            java.lang.Object element)

Description copied from interface: java.util.List

Replace an element of this list with another object (optional operation).

Specified by:: set in interface java.util.List

add

public void add(int index,
                java.lang.Object element)

Description copied from interface: java.util.List

Insert an element into the list at a given position (optional operation). This shifts all existing elements from that position to the end one index to the right. This version of add has no return, since it is assumed to always succeed if there is no exception.

Specified by:: add in interface java.util.List

remove

public java.lang.Object remove(int index)

Description copied from interface: java.util.List

Remove the element at a given position in this list (optional operation). Shifts all remaining elements to the left to fill the gap.

Specified by:: remove in interface java.util.List

indexOf

public int indexOf(java.lang.Object o)

Description copied from interface: java.util.List

Obtain the first index at which a given object is to be found in this list.

Specified by:: indexOf in interface java.util.List

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Description copied from interface: java.util.List

Obtain the last index at which a given object is to be found in this list.

Specified by:: lastIndexOf in interface java.util.List

listIterator

public java.util.ListIterator listIterator()

Description copied from interface: java.util.List

Obtain a ListIterator over this list, starting at the beginning.

Specified by:: listIterator in interface java.util.List

listIterator

public java.util.ListIterator listIterator(int index)

Description copied from interface: java.util.List

Obtain a ListIterator over this list, starting at a given position. A first call to next() would return the same as get(index), and a first call to previous() would return the same as get(index - 1).

Specified by:: listIterator in interface java.util.List

subList

public java.util.List subList(int from,
                              int to)

Description copied from interface: java.util.List

Obtain a List view of a subsection of this list, from fromIndex (inclusive) to toIndex (exclusive). If the two indices are equal, the sublist is empty. The returned list should be modifiable if and only if this list is modifiable. Changes to the returned list should be reflected in this list. If this list is structurally modified in any way other than through the returned list, the result of any subsequent operations on the returned list is undefined.

Specified by:: subList in interface java.util.List

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

getPropertyName

protected java.lang.String getPropertyName()

firePropertyChangeEvent

protected void firePropertyChangeEvent(java.beans.PropertyChangeEvent event)

Implemented by subclasses to deliver a change event to the appropriately registered listeners.

fireElementsInserted

public void fireElementsInserted(int first,
                                 int last)

Sends an event to interested listeners that this property has had elements inserted. These methods are public so that changes made external to the internal data structures can still cause notifications.

fireElementsModified

public void fireElementsModified(int first,
                                 int last)

fireElementsRemoved

public void fireElementsRemoved(int first,
                                int last)

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> progeeks >> [ util overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Nested Class Summary
`private class`	`ObservableList.ObservableIterator` Iterator class that makes sure to take care of notifications.
`private class`	`ObservableList.ObservableListIterator` List iterator class that makes sure to take care of notifications.

Field Summary
`private java.util.List`	`list`
`private java.util.List`	`listeners`

Constructor Summary
`ObservableList(java.util.List list)`

Method Summary
`void`	`add(int index, java.lang.Object element)` Insert an element into the list at a given position (optional operation).
`boolean`	`add(java.lang.Object o)` Add an element to the end of the list (optional operation).
`boolean`	`addAll(java.util.Collection c)` Add the contents of a collection to the end of the list (optional operation).
`boolean`	`addAll(int index, java.util.Collection c)` Insert the contents of a collection into the list at a given position (optional operation).
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)`
`void`	`clear()` Clear the list, such that a subsequent call to isEmpty() would return true (optional operation).
`boolean`	`contains(java.lang.Object o)` Test whether this list contains a given object as one of its elements.
`boolean`	`containsAll(java.util.Collection c)` Test whether this list contains every element in a given collection.
`boolean`	`equals(java.lang.Object o)` Test whether this list is equal to another object.
`void`	`fireElementsInserted(int first, int last)` Sends an event to interested listeners that this property has had elements inserted.
`void`	`fireElementsModified(int first, int last)` Sends an event to interested listeners that this property has had elements inserted.
`void`	`fireElementsRemoved(int first, int last)` Sends an event to interested listeners that this property has had elements inserted.
`protected void`	`firePropertyChangeEvent(java.beans.PropertyChangeEvent event)` Implemented by subclasses to deliver a change event to the appropriately registered listeners.
`java.lang.Object`	`get(int index)` Get the element at a given index in this list.
`protected java.lang.String`	`getPropertyName()`
`int`	`hashCode()` Obtains a hash code for this list.
`int`	`indexOf(java.lang.Object o)` Obtain the first index at which a given object is to be found in this list.
`boolean`	`isEmpty()` Test whether this list is empty, that is, if size() == 0.
`java.util.Iterator`	`iterator()` Obtain an Iterator over this list, whose sequence is the list order.
`int`	`lastIndexOf(java.lang.Object o)` Obtain the last index at which a given object is to be found in this list.
`java.util.ListIterator`	`listIterator()` Obtain a ListIterator over this list, starting at the beginning.
`java.util.ListIterator`	`listIterator(int index)` Obtain a ListIterator over this list, starting at a given position.
`java.lang.Object`	`remove(int index)` Remove the element at a given position in this list (optional operation).
`boolean`	`remove(java.lang.Object o)` Remove the first occurence of an object from this list (optional operation).
`boolean`	`removeAll(java.util.Collection c)` Remove all elements of a given collection from this list (optional operation).
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)`
`boolean`	`retainAll(java.util.Collection c)` Remove all elements of this list that are not contained in a given collection (optional operation).
`java.lang.Object`	`set(int index, java.lang.Object element)` Replace an element of this list with another object (optional operation).
`int`	`size()` Get the number of elements in this list.
`java.util.List`	`subList(int from, int to)` Obtain a List view of a subsection of this list, from fromIndex (inclusive) to toIndex (exclusive).
`java.lang.Object[]`	`toArray()` Copy the current contents of this list into an array.
`java.lang.Object[]`	`toArray(java.lang.Object[] a)` Copy the current contents of this list into an array.
`java.lang.String`	`toString()` Convert this Object to a human-readable String.

org.progeeks.util Class ObservableList

list

listeners

ObservableList

size

isEmpty

contains

iterator

toArray

toArray

add

remove

containsAll

addAll

addAll

removeAll

retainAll

clear

equals

hashCode

get

set

add

remove

indexOf

lastIndexOf

listIterator

listIterator

subList

addPropertyChangeListener

removePropertyChangeListener

getPropertyName

firePropertyChangeEvent

fireElementsInserted

fireElementsModified

fireElementsRemoved

toString

org.progeeks.util
Class ObservableList