Top Description Inners Fields Constructors Methods
groovy.util

public Class ObservableSet<E>

extends Object
implements Set<E>
Class Inheritance
All Implemented Interfaces
java.util.Set, java.util.Collection, java.lang.Iterable
Imports
groovy.lang.Closure, java.beans.PropertyChangeEvent, .PropertyChangeListener, .PropertyChangeSupport, java.util.ArrayList, .Collection, .Collections, .HashSet, .Iterator, .List, .Set, .Stack

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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
public static class
public static class
public abstract static class
public static class
public static class
public static class
protected class

Field Summary

Modifier and TypeField and Description
public static final String
private final Set<E>
private final PropertyChangeSupport
public static final String
private final Closure<V>

Constructor Summary

AccessConstructor and Description
public
public
ObservableSet(Set<E> delegate)

public
public
ObservableSet(Set<E> delegate, Closure<V> test)

Method Summary

Modifier and TypeMethod and Description
public boolean
add(E
element to be added to this set
e
)

Implements java.util.Set.add.

Adds the specified element to this set if it is not already present (optional operation).
public boolean
addAll(Collection<? extends E>
collection containing elements to be added to this set
c
)

Implements java.util.Set.addAll.

Adds all of the elements in the specified collection to this set if they're not already present (optional operation).
public void
public void
public void
clear()

Implements java.util.Set.clear.

Removes all of the elements from this set (optional operation).
public boolean
contains(Object
element whose presence in this set is to be tested
o
)

Implements java.util.Set.contains.

Returns true if this set contains the specified element.
public boolean
containsAll(Collection<?>
collection to be checked for containment in this set
objects
)

Implements java.util.Set.containsAll.

Returns true if this set contains all of the elements of the specified collection.
protected void
protected void
protected void
protected void
protected void
protected void
protected void
fireSizeChangedEvent(int oldValue, int newValue)

public Set<E>
protected Set<E>
public PropertyChangeListener[]
public PropertyChangeListener[]
protected Closure<V>
public boolean
hasListeners(String propertyName)

public boolean
isEmpty()

Implements java.util.Set.isEmpty.

Returns true if this set contains no elements.
public Iterator<E>
iterator()

Implements java.util.Set.iterator.

Returns an iterator over the elements in this set.
public boolean
remove(Object
object to be removed from this set, if present
o
)

Implements java.util.Set.remove.

Removes the specified element from this set if it is present (optional operation).
public boolean
removeAll(Collection<?>
collection containing elements to be removed from this set
c
)

Implements java.util.Set.removeAll.

Removes from this set all of its elements that are contained in the specified collection (optional operation).
public void
public void
public boolean
retainAll(Collection<?>
collection containing elements to be retained in this set
c
)

Implements java.util.Set.retainAll.

Retains only the elements in this set that are contained in the specified collection (optional operation).
public int
size()

Implements java.util.Set.size.

Returns the number of elements in this set (its cardinality).
public Object[]
toArray()

Implements java.util.Set.toArray.

Returns an array containing all of the elements in this set.
public <T> T[]
toArray(T[]
the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
ts
)

Implements java.util.Set.toArray.

Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CONTENT_PROPERTYback to summary
public static final String CONTENT_PROPERTY
delegateback to summary
private final Set<E> delegate
pcsback to summary
private final PropertyChangeSupport pcs
SIZE_PROPERTYback to summary
public static final String SIZE_PROPERTY
testback to summary
private final Closure<V> test

Constructor Detail

ObservableSetback to summary
public ObservableSet()
ObservableSetback to summary
public ObservableSet(Set<E> delegate)
ObservableSetback to summary
public ObservableSet(Closure<V> test)
ObservableSetback to summary
public ObservableSet(Set<E> delegate, Closure<V> test)

Method Detail

addback to summary
public boolean add(E e)

Implements java.util.Set.add.

Doc from java.util.Set.add.

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element e to this set if the set contains no element e2 such that Objects.equals(e, e2). If this set already contains the element, the call leaves the set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throw an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the elements that they may contain.

Parameters
e:E

element to be added to this set

Returns:boolean

true if this set did not already contain the specified element

addAllback to summary
public boolean addAll(Collection<? extends E> c)

Implements java.util.Set.addAll.

Doc from java.util.Set.addAll.

Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Parameters
c:Collection<? extends E>

collection containing elements to be added to this set

Returns:boolean

true if this set changed as a result of the call

addPropertyChangeListenerback to summary
public void addPropertyChangeListener(PropertyChangeListener listener)
addPropertyChangeListenerback to summary
public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
clearback to summary
public void clear()

Implements java.util.Set.clear.

Doc from java.util.Set.clear.

Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

containsback to summary
public boolean contains(Object o)

Implements java.util.Set.contains.

Doc from java.util.Set.contains.

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that Objects.equals(o, e).

Parameters
o:Object

element whose presence in this set is to be tested

Returns:boolean

true if this set contains the specified element

containsAllback to summary
public boolean containsAll(Collection<?> objects)

Implements java.util.Set.containsAll.

Doc from java.util.Set.containsAll.

Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.

Parameters
objects:Collection<?>

collection to be checked for containment in this set

Returns:boolean

true if this set contains all of the elements of the specified collection

fireElementAddedEventback to summary
protected void fireElementAddedEvent(Object element)
fireElementClearedEventback to summary
protected void fireElementClearedEvent(List<E> values)
fireElementEventback to summary
protected void fireElementEvent(ObservableSet.ElementEvent event)
fireElementRemovedEventback to summary
protected void fireElementRemovedEvent(Object element)
fireMultiElementAddedEventback to summary
protected void fireMultiElementAddedEvent(List<E> values)
fireMultiElementRemovedEventback to summary
protected void fireMultiElementRemovedEvent(List<E> values)
fireSizeChangedEventback to summary
protected void fireSizeChangedEvent(int oldValue, int newValue)
getContentback to summary
public Set<E> getContent()
getDelegateSetback to summary
protected Set<E> getDelegateSet()
getPropertyChangeListenersback to summary
public PropertyChangeListener[] getPropertyChangeListeners()
getPropertyChangeListenersback to summary
public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
getTestback to summary
protected Closure<V> getTest()
hasListenersback to summary
public boolean hasListeners(String propertyName)
isEmptyback to summary
public boolean isEmpty()

Implements java.util.Set.isEmpty.

Doc from java.util.Set.isEmpty.

Returns true if this set contains no elements.

Returns:boolean

true if this set contains no elements

iteratorback to summary
public Iterator<E> iterator()

Implements java.util.Set.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Returns:Iterator<E>

an iterator over the elements in this set

removeback to summary
public boolean remove(Object o)

Implements java.util.Set.remove.

Doc from java.util.Set.remove.

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Parameters
o:Object

object to be removed from this set, if present

Returns:boolean

true if this set contained the specified element

removeAllback to summary
public boolean removeAll(Collection<?> c)

Implements java.util.Set.removeAll.

Doc from java.util.Set.removeAll.

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

Parameters
c:Collection<?>

collection containing elements to be removed from this set

Returns:boolean

true if this set changed as a result of the call

removePropertyChangeListenerback to summary
public void removePropertyChangeListener(PropertyChangeListener listener)
removePropertyChangeListenerback to summary
public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
retainAllback to summary
public boolean retainAll(Collection<?> c)

Implements java.util.Set.retainAll.

Doc from java.util.Set.retainAll.

Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.

Parameters
c:Collection<?>

collection containing elements to be retained in this set

Returns:boolean

true if this set changed as a result of the call

sizeback to summary
public int size()

Implements java.util.Set.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of elements in this set (its cardinality)

toArrayback to summary
public Object[] toArray()

Implements java.util.Set.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Returns:Object[]

an array containing all the elements in this set

toArrayback to summary
public <T> T[] toArray(T[] ts)

Implements java.util.Set.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. If the set fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this set.

If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to null. (This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.)

If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a set known to contain only strings. The following code can be used to dump the set into a newly allocated array of String:

    String[] y = x.toArray(new String[0]);
Note that toArray(new Object[0]) is identical in function to toArray().
Parameters
<T>

Doc from java.util.Collection.toArray. the component type of the array to contain the collection

ts:T[]

the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:T[]

an array containing all the elements in this set

groovy.util back to summary

public final Enum ObservableSet.ChangeType

extends Enum<ObservableSet.ChangeType>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final ObservableSet.ChangeType
public static final ObservableSet.ChangeType
public static final ObservableSet.ChangeType
public static final ObservableSet.ChangeType
public static final Object
public static final ObservableSet.ChangeType
public static final Object
public static final ObservableSet.ChangeType

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static ObservableSet.ChangeType
public static ObservableSet.ChangeType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ADDEDback to summary
public static final ObservableSet.ChangeType ADDED
CLEAREDback to summary
public static final ObservableSet.ChangeType CLEARED
MULTI_ADDback to summary
public static final ObservableSet.ChangeType MULTI_ADD
MULTI_REMOVEback to summary
public static final ObservableSet.ChangeType MULTI_REMOVE
newValueback to summary
public static final Object newValue
NONEback to summary
public static final ObservableSet.ChangeType NONE
oldValueback to summary
public static final Object oldValue
REMOVEDback to summary
public static final ObservableSet.ChangeType REMOVED

Constructor Detail

ChangeTypeback to summary
private ChangeType()

Method Detail

valueOfback to summary
public static ObservableSet.ChangeType valueOf(String name)
valuesback to summary
public static ObservableSet.ChangeType[] values()
groovy.util back to summary

public Class ObservableSet.ElementAddedEvent

extends ElementEvent
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public
ElementAddedEvent(Object source, Object newValue)

Method Summary

Inherited from groovy.util.ObservableSet.ElementEvent:
getChangeTypegetTypegetTypeAsString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides groovy.util.ObservableSet.ElementEvent.serialVersionUID.

Constructor Detail

ElementAddedEventback to summary
public ElementAddedEvent(Object source, Object newValue)
groovy.util back to summary

public Class ObservableSet.ElementClearedEvent

extends ElementEvent
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long
private List<E>

Constructor Summary

AccessConstructor and Description
public
ElementClearedEvent(Object source, List<E> values)

Method Summary

Modifier and TypeMethod and Description
public List<E>
Inherited from groovy.util.ObservableSet.ElementEvent:
getChangeTypegetTypegetTypeAsString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides groovy.util.ObservableSet.ElementEvent.serialVersionUID.

valuesback to summary
private List<E> values

Constructor Detail

ElementClearedEventback to summary
public ElementClearedEvent(Object source, List<E> values)

Method Detail

getValuesback to summary
public List<E> getValues()
groovy.util back to summary

public abstract Class ObservableSet.ElementEvent

extends PropertyChangeEvent
Class Inheritance
Known Direct Subclasses
groovy.util.ObservableSet.ElementAddedEvent, groovy.util.ObservableSet.ElementRemovedEvent, groovy.util.ObservableSet.ElementClearedEvent, groovy.util.ObservableSet.MultiElementAddedEvent, groovy.util.ObservableSet.MultiElementRemovedEvent

Field Summary

Modifier and TypeField and Description
private static final long
private final ObservableSet.ChangeType

Constructor Summary

AccessConstructor and Description
public
ElementEvent(Object source, Object oldValue, Object newValue, ObservableSet.ChangeType type)

Method Summary

Modifier and TypeMethod and Description
public ObservableSet.ChangeType
public int
public String
Inherited from java.beans.PropertyChangeEvent:
getNewValuegetOldValuegetPropagationIdgetPropertyNamesetPropagationIdtoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.beans.PropertyChangeEvent.serialVersionUID.

typeback to summary
private final ObservableSet.ChangeType type

Constructor Detail

ElementEventback to summary
public ElementEvent(Object source, Object oldValue, Object newValue, ObservableSet.ChangeType type)

Method Detail

getChangeTypeback to summary
public ObservableSet.ChangeType getChangeType()
getTypeback to summary
public int getType()
getTypeAsStringback to summary
public String getTypeAsString()
groovy.util back to summary

public Class ObservableSet.ElementRemovedEvent

extends ElementEvent
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Inherited from groovy.util.ObservableSet.ElementEvent:
getChangeTypegetTypegetTypeAsString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides groovy.util.ObservableSet.ElementEvent.serialVersionUID.

Constructor Detail

ElementRemovedEventback to summary
public ElementRemovedEvent(Object source, Object value)
groovy.util back to summary

public Class ObservableSet.MultiElementAddedEvent

extends ElementEvent
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long
private List<E>

Constructor Summary

AccessConstructor and Description
public
MultiElementAddedEvent(Object source, List<E> values)

Method Summary

Modifier and TypeMethod and Description
public List<E>
Inherited from groovy.util.ObservableSet.ElementEvent:
getChangeTypegetTypegetTypeAsString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides groovy.util.ObservableSet.ElementEvent.serialVersionUID.

valuesback to summary
private List<E> values

Constructor Detail

MultiElementAddedEventback to summary
public MultiElementAddedEvent(Object source, List<E> values)

Method Detail

getValuesback to summary
public List<E> getValues()
groovy.util back to summary

public Class ObservableSet.MultiElementRemovedEvent

extends ElementEvent
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long
private List<E>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public List<E>
Inherited from groovy.util.ObservableSet.ElementEvent:
getChangeTypegetTypegetTypeAsString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides groovy.util.ObservableSet.ElementEvent.serialVersionUID.

valuesback to summary
private List<E> values

Constructor Detail

MultiElementRemovedEventback to summary
public MultiElementRemovedEvent(Object source, List<E> values)

Method Detail

getValuesback to summary
public List<E> getValues()
groovy.util back to summary

protected Class ObservableSet.ObservableIterator<E>

extends Object
implements Iterator<E>
Class Inheritance
All Implemented Interfaces
java.util.Iterator

Field Summary

Modifier and TypeField and Description
private final Iterator<E>
private final Stack<E>

Constructor Summary

AccessConstructor and Description
public
ObservableIterator(Iterator<E> iterDelegate)

Method Summary

Modifier and TypeMethod and Description
public Iterator<E>
public boolean
hasNext()

Implements java.util.Iterator.hasNext.

Returns true if the iteration has more elements.
public E
next()

Implements java.util.Iterator.next.

Returns the next element in the iteration.
public void
remove()

Overrides default java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation).
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

iterDelegateback to summary
private final Iterator<E> iterDelegate
stackback to summary
private final Stack<E> stack

Constructor Detail

ObservableIteratorback to summary
public ObservableIterator(Iterator<E> iterDelegate)

Method Detail

getDelegateback to summary
public Iterator<E> getDelegate()
hasNextback to summary
public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

nextback to summary
public E next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:E

the next element in the iteration

removeback to summary
public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.