ObservableList (Groovy 6.0.0-alpha-1)

groovy.util.ObservableList

All Implemented Interfaces and Traits:

List
```
public class ObservableList
extends Object
implements List
```
List decorator that will trigger PropertyChangeEvents when a value changes.
An optional Closure may be specified and will work as a filter, if it returns true the property will trigger an event (if the value indeed changed), otherwise it won't. The Closure may receive 1 or 2 parameters, the single one being the value, the other one both the key and value, for example:
```
 // skip all properties whose value is a closure
 def map = new ObservableList( {!(it instanceof Closure)} )

 // skip all properties whose name matches a regex
 def map = new ObservableList( { name, value -> !(name =˜ /[A-Z+]/) } )
 
```
The current implementation will trigger specialized events in the following scenarios, you need not register a different listener as those events extend from PropertyChangeEvent
- ObservableList.ElementAddedEvent - a new element is added to the list
- ObservableList.ElementRemovedEvent - an element is removed from the list
- ObservableList.ElementUpdatedEvent - an element changes value (same as regular PropertyChangeEvent)
- ObservableList.ElementClearedEvent - all elements have been removed from the list
- ObservableList.MultiElementAddedEvent - triggered by calling list.addAll()
- ObservableList.MultiElementRemovedEvent - triggered by calling list.removeAll()/list.retainAll()
Bound properties
- content - read-only.
- size - read-only.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`enum`	`ObservableList.ChangeType`	Enumerates the specialized list change events.
`static class`	`ObservableList.ElementAddedEvent`	Event fired when one element is added.
`static class`	`ObservableList.ElementClearedEvent`	Event fired when the list is cleared.
`static class`	`ObservableList.ElementEvent`	Base event type for observable list content changes.
`static class`	`ObservableList.ElementRemovedEvent`	Event fired when one element is removed.
`static class`	`ObservableList.ElementUpdatedEvent`	Event fired when one element is updated.
`static class`	`ObservableList.MultiElementAddedEvent`	Event fired when multiple elements are added.
`static class`	`ObservableList.MultiElementRemovedEvent`	Event fired when multiple elements are removed.
`protected class`	`ObservableList.ObservableIterator`	Iterator wrapper that reports removals as observable list events.
`protected class`	`ObservableList.ObservableListIterator`	List iterator wrapper that routes mutations through ObservableList.

Field Summary

Fields
Modifiers	Name	Description
`static String`	`CONTENT_PROPERTY`	Bound property name for list content changes.
`static String`	`SIZE_PROPERTY`	Bound property name for list size changes.

Constructor Summary

Constructors
Constructor and description
`ObservableList()` Creates an observable list backed by an ArrayList.
`ObservableList(List delegate)` Creates an observable list backed by the supplied delegate.
`ObservableList(Closure test)` Creates an observable list backed by an ArrayList.
`ObservableList(List delegate, Closure test)` Creates an observable list backed by the supplied delegate.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`add(int index, Object element)` {@inheritDoc}
	`public boolean`	`add(Object o)` {@inheritDoc}
	`public boolean`	`addAll(Collection c)` {@inheritDoc}
	`public boolean`	`addAll(int index, Collection c)` {@inheritDoc}
	`public void`	`addPropertyChangeListener(PropertyChangeListener listener)` Registers a listener for all observable list events.
	`public void`	`addPropertyChangeListener(String propertyName, PropertyChangeListener listener)` Registers a listener for a named bound property.
	`public void`	`clear()` {@inheritDoc}
	`public boolean`	`contains(Object o)` {@inheritDoc}
	`public boolean`	`containsAll(Collection c)` {@inheritDoc}
	`public boolean`	`equals(Object o)` {@inheritDoc}
	`protected void`	`fireElementAddedEvent(int index, Object element)` Fires a single-element added event.
	`protected void`	`fireElementClearedEvent(List values)` Fires a cleared event containing removed values.
	`protected void`	`fireElementEvent(ObservableList.ElementEvent event)` Publishes an element event to registered listeners.
	`protected void`	`fireElementRemovedEvent(int index, Object element)` Fires a single-element removed event.
	`protected void`	`fireElementUpdatedEvent(int index, Object oldValue, Object newValue)` Fires a single-element updated event.
	`protected void`	`fireMultiElementAddedEvent(int index, List values)` Fires a multi-element added event.
	`protected void`	`fireMultiElementRemovedEvent(List values)` Fires a multi-element removed event.
	`protected void`	`fireSizeChangedEvent(int oldValue, int newValue)` Fires the bound size change event.
	`public Object`	`get(int index)` {@inheritDoc}
	`public List`	`getContent()` Returns an unmodifiable snapshot view of the backing list.
	`protected List`	`getDelegateList()` Returns the mutable backing list.
	`public PropertyChangeListener[]`	`getPropertyChangeListeners()` Returns listeners registered for all properties.
	`public PropertyChangeListener[]`	`getPropertyChangeListeners(String propertyName)` Returns listeners registered for a named property.
	`public int`	`getSize()` Returns the current list size as a bound property value.
	`protected Closure`	`getTest()` Returns the optional event filter closure.
	`public boolean`	`hasListeners(String propertyName)` Reports whether listeners are registered for a named property.
	`public int`	`hashCode()` {@inheritDoc}
	`public int`	`indexOf(Object o)` {@inheritDoc}
	`public boolean`	`isEmpty()` {@inheritDoc}
	`public Iterator`	`iterator()` {@inheritDoc}
	`public int`	`lastIndexOf(Object o)` {@inheritDoc}
	`public ListIterator`	`listIterator()` {@inheritDoc}
	`public ListIterator`	`listIterator(int index)` {@inheritDoc}
	`public Object`	`remove(int index)` {@inheritDoc}
	`public boolean`	`remove(Object o)` {@inheritDoc}
	`public boolean`	`removeAll(Collection c)` {@inheritDoc}
	`public void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a listener registered for all properties.
	`public void`	`removePropertyChangeListener(String propertyName, PropertyChangeListener listener)` Removes a listener registered for a named property.
	`public boolean`	`retainAll(Collection c)` {@inheritDoc}
	`public Object`	`set(int index, Object element)` {@inheritDoc}
	`public int`	`size()` {@inheritDoc}
	`public List`	`subList(int fromIndex, int toIndex)` {@inheritDoc}
	`public Object[]`	`toArray()` {@inheritDoc}
	`public Object[]`	`toArray(Object[] a)` {@inheritDoc}

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - public static final String CONTENT_PROPERTY
    
    Bound property name for list content changes.
  - public static final String SIZE_PROPERTY
    
    Bound property name for list size changes.
- Constructor Detail
  - public ObservableList()
    
    Creates an observable list backed by an ArrayList.
  - public ObservableList(List delegate)
    
    Creates an observable list backed by the supplied delegate.
    Parameters:
    delegate - the backing list
  - public ObservableList(Closure test)
    
    Creates an observable list backed by an ArrayList.
    Parameters:
    test - optional event filter
  - public ObservableList(List delegate, Closure test)
    
    Creates an observable list backed by the supplied delegate.
    Parameters:
    delegate - the backing list
    test - optional event filter
- Method Detail
  - public void add(int index, Object element)
    
    {@inheritDoc}
  - public boolean add(Object o)
    
    {@inheritDoc}
  - public boolean addAll(Collection c)
    
    {@inheritDoc}
  - public boolean addAll(int index, Collection c)
    
    {@inheritDoc}
  - public void addPropertyChangeListener(PropertyChangeListener listener)
    
    Registers a listener for all observable list events.
    Parameters:
    listener - the listener to add
  - public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
    
    Registers a listener for a named bound property.
    Parameters:
    propertyName - the property to observe
    listener - the listener to add
  - public void clear()
    
    {@inheritDoc}
  - public boolean contains(Object o)
    
    {@inheritDoc}
  - public boolean containsAll(Collection c)
    
    {@inheritDoc}
  - public boolean equals(Object o)
    
    {@inheritDoc}
  - protected void fireElementAddedEvent(int index, Object element)
    
    Fires a single-element added event.
  - protected void fireElementClearedEvent(List values)
    
    Fires a cleared event containing removed values.
  - protected void fireElementEvent(ObservableList.ElementEvent event)
    
    Publishes an element event to registered listeners.
  - protected void fireElementRemovedEvent(int index, Object element)
    
    Fires a single-element removed event.
  - protected void fireElementUpdatedEvent(int index, Object oldValue, Object newValue)
    
    Fires a single-element updated event.
  - protected void fireMultiElementAddedEvent(int index, List values)
    
    Fires a multi-element added event.
  - protected void fireMultiElementRemovedEvent(List values)
    
    Fires a multi-element removed event.
  - protected void fireSizeChangedEvent(int oldValue, int newValue)
    
    Fires the bound size change event.
  - public Object get(int index)
    
    {@inheritDoc}
  - public List getContent()
    
    Returns an unmodifiable snapshot view of the backing list.
    Returns:
    the list content
  - protected List getDelegateList()
    
    Returns the mutable backing list.
    Returns:
    the delegate list
  - public PropertyChangeListener[] getPropertyChangeListeners()
    
    Returns listeners registered for all properties.
    Returns:
    the registered listeners
  - public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
    
    Returns listeners registered for a named property.
    Parameters:
    propertyName - the observed property name
    Returns:
    the registered listeners
  - public int getSize()
    
    Returns the current list size as a bound property value.
    Returns:
    the current list size
  - protected Closure getTest()
    
    Returns the optional event filter closure.
    Returns:
    the event filter, or null
  - public boolean hasListeners(String propertyName)
    
    Reports whether listeners are registered for a named property.
    Parameters:
    propertyName - the property name to inspect
    Returns:
    true if listeners are registered
  - public int hashCode()
    
    {@inheritDoc}
  - public int indexOf(Object o)
    
    {@inheritDoc}
  - public boolean isEmpty()
    
    {@inheritDoc}
  - public Iterator iterator()
    
    {@inheritDoc}
  - public int lastIndexOf(Object o)
    
    {@inheritDoc}
  - public ListIterator listIterator()
    
    {@inheritDoc}
  - public ListIterator listIterator(int index)
    
    {@inheritDoc}
  - public Object remove(int index)
    
    {@inheritDoc}
  - public boolean remove(Object o)
    
    {@inheritDoc}
  - public boolean removeAll(Collection c)
    
    {@inheritDoc}
  - public void removePropertyChangeListener(PropertyChangeListener listener)
    
    Removes a listener registered for all properties.
    Parameters:
    listener - the listener to remove
  - public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
    
    Removes a listener registered for a named property.
    Parameters:
    propertyName - the observed property name
    listener - the listener to remove
  - public boolean retainAll(Collection c)
    
    {@inheritDoc}
  - public Object set(int index, Object element)
    
    {@inheritDoc}
  - public int size()
    
    {@inheritDoc}
  - public List subList(int fromIndex, int toIndex)
    
    {@inheritDoc}
  - public Object[] toArray()
    
    {@inheritDoc}
  - public Object[] toArray(Object[] a)
    
    {@inheritDoc}

| Detail:
Field
Constructor
Method

[Java] Class ObservableList

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String CONTENT_PROPERTY

public static final String SIZE_PROPERTY

Constructor Detail

public ObservableList()

public ObservableList(List delegate)

public ObservableList(Closure test)

public ObservableList(List delegate, Closure test)

Method Detail

public void add(int index, Object element)

public boolean add(Object o)

public boolean addAll(Collection c)

public boolean addAll(int index, Collection c)

public void addPropertyChangeListener(PropertyChangeListener listener)

public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)

public void clear()

public boolean contains(Object o)

public boolean containsAll(Collection c)

public boolean equals(Object o)

protected void fireElementAddedEvent(int index, Object element)

protected void fireElementClearedEvent(List values)

protected void fireElementEvent(ObservableList.ElementEvent event)

protected void fireElementRemovedEvent(int index, Object element)

protected void fireElementUpdatedEvent(int index, Object oldValue, Object newValue)

protected void fireMultiElementAddedEvent(int index, List values)

protected void fireMultiElementRemovedEvent(List values)

protected void fireSizeChangedEvent(int oldValue, int newValue)

public Object get(int index)

public List getContent()

protected List getDelegateList()

public PropertyChangeListener[] getPropertyChangeListeners()

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)

public int getSize()

protected Closure getTest()

public boolean hasListeners(String propertyName)

public int hashCode()

public int indexOf(Object o)

public boolean isEmpty()

public Iterator iterator()

public int lastIndexOf(Object o)

public ListIterator listIterator()

public ListIterator listIterator(int index)

public Object remove(int index)

public boolean remove(Object o)

public boolean removeAll(Collection c)

public void removePropertyChangeListener(PropertyChangeListener listener)

public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)

public boolean retainAll(Collection c)

public Object set(int index, Object element)

public int size()

public List subList(int fromIndex, int toIndex)

public Object[] toArray()

public Object[] toArray(Object[] a)