Groovy 2.2.1

groovy.util
[Java] Class ObservableSet

java.lang.Object
  groovy.util.ObservableSet
All Implemented Interfaces:
Set

public class ObservableSet
extends Object

Set 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 set = new ObservableSet( {!(it instanceof Closure)} )
 <p/>
 // skip all properties whose name matches a regex
 def set = new ObservableSet( { 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

Bound properties

Authors:
Andres Almiray


Nested Class Summary
enum ObservableSet.ChangeType

static class ObservableSet.ElementAddedEvent

static class ObservableSet.ElementClearedEvent

static class ObservableSet.ElementEvent

static class ObservableSet.ElementRemovedEvent

static class ObservableSet.MultiElementAddedEvent

static class ObservableSet.MultiElementRemovedEvent

protected class ObservableSet.ObservableIterator

 
Field Summary
static String CONTENT_PROPERTY

static String SIZE_PROPERTY

 
Constructor Summary
ObservableSet()

ObservableSet(Set delegate)

ObservableSet(Closure test)

ObservableSet(Set delegate, Closure test)

 
Method Summary
boolean add(E e)

boolean addAll(Collection c)

void addPropertyChangeListener(PropertyChangeListener listener)

void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)

void clear()

boolean contains(Object o)

boolean containsAll(Collection objects)

protected void fireElementAddedEvent(Object element)

protected void fireElementClearedEvent(List values)

protected void fireElementEvent(ObservableSet.ElementEvent event)

protected void fireElementRemovedEvent(Object element)

protected void fireMultiElementAddedEvent(List values)

protected void fireMultiElementRemovedEvent(List values)

protected void fireSizeChangedEvent(int oldValue, int newValue)

Set getContent()

protected Set getDelegateSet()

PropertyChangeListener[] getPropertyChangeListeners()

PropertyChangeListener[] getPropertyChangeListeners(String propertyName)

protected Closure getTest()

boolean hasListeners(String propertyName)

boolean isEmpty()

Iterator iterator()

boolean remove(Object o)

boolean removeAll(Collection c)

void removePropertyChangeListener(PropertyChangeListener listener)

void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)

boolean retainAll(Collection c)

int size()

Object[] toArray()

Object[] toArray(Object[] ts)

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

Field Detail

CONTENT_PROPERTY

public static final String CONTENT_PROPERTY


SIZE_PROPERTY

public static final String SIZE_PROPERTY


 
Constructor Detail

ObservableSet

public ObservableSet()


ObservableSet

public ObservableSet(Set delegate)


ObservableSet

public ObservableSet(Closure test)


ObservableSet

public ObservableSet(Set delegate, Closure test)


 
Method Detail

add

public boolean add(E e)


addAll

public boolean addAll(Collection c)


addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)


addPropertyChangeListener

public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)


clear

public void clear()


contains

public boolean contains(Object o)


containsAll

public boolean containsAll(Collection objects)


fireElementAddedEvent

protected void fireElementAddedEvent(Object element)


fireElementClearedEvent

protected void fireElementClearedEvent(List values)


fireElementEvent

protected void fireElementEvent(ObservableSet.ElementEvent event)


fireElementRemovedEvent

protected void fireElementRemovedEvent(Object element)


fireMultiElementAddedEvent

protected void fireMultiElementAddedEvent(List values)


fireMultiElementRemovedEvent

protected void fireMultiElementRemovedEvent(List values)


fireSizeChangedEvent

protected void fireSizeChangedEvent(int oldValue, int newValue)


getContent

public Set getContent()


getDelegateSet

protected Set getDelegateSet()


getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()


getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)


getTest

protected Closure getTest()


hasListeners

public boolean hasListeners(String propertyName)


isEmpty

public boolean isEmpty()


iterator

public Iterator iterator()


remove

public boolean remove(Object o)


removeAll

public boolean removeAll(Collection c)


removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)


removePropertyChangeListener

public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)


retainAll

public boolean retainAll(Collection c)


size

public int size()


toArray

public Object[] toArray()


toArray

public Object[] toArray(Object[] ts)


 

Copyright &copy; 2003-2013 The Codehaus. All rights reserved.