javafx.beans.binding

Class SetExpression<E>

java.lang.Object

javafx.beans.binding.SetExpression<E>

Type Parameters:

E - the type of the Set elements

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>, Observable, ObservableObjectValue<ObservableSet<E>>, ObservableSetValue<E>, ObservableValue<ObservableSet<E>>, ObservableSet<E>

Direct Known Subclasses:

ReadOnlySetProperty, SetBinding

public abstract class SetExpression<E>
extends java.lang.Object
implements ObservableSetValue<E>

A SetExpression is a ObservableSetValue plus additional convenience methods to generate bindings in a fluent style.

A concrete sub-class of SetExpression has to implement the method ObservableObjectValue.get(), which provides the actual value of this expression.

If the wrapped list of a SetExpression is null, all methods implementing the Set interface will behave as if they were applied to an immutable empty set.

Property Summary

Properties

Type	Property and Description
abstract ReadOnlyBooleanProperty	empty
abstract ReadOnlyIntegerProperty	size A boolean property that is true, if the set is empty.

Constructor Summary

Constructors

Constructor and Description
SetExpression()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E element)
boolean	addAll(java.util.Collection<? extends E> elements)
StringBinding	asString() Creates a StringBinding that holds the value of the SetExpression turned into a String.
void	clear()
boolean	contains(java.lang.Object obj)
boolean	containsAll(java.util.Collection<?> objects)
abstract ReadOnlyBooleanProperty	emptyProperty()
int	getSize() The size of the set
ObservableSet<E>	getValue() Returns the current value of this ObservableValue
boolean	isEmpty() Gets the value of the property empty.
BooleanBinding	isEqualTo(ObservableSet<?> other) Creates a new BooleanBinding that holds true if this set is equal to another ObservableSet.
BooleanBinding	isNotEqualTo(ObservableSet<?> other) Creates a new BooleanBinding that holds true if this set is not equal to another ObservableSet.
BooleanBinding	isNotNull() Creates a new BooleanBinding that holds true if the wrapped set is not null.
BooleanBinding	isNull() Creates a new BooleanBinding that holds true if the wrapped set is null.
java.util.Iterator<E>	iterator()
boolean	remove(java.lang.Object obj)
boolean	removeAll(java.util.Collection<?> objects)
boolean	retainAll(java.util.Collection<?> objects)
static <E> SetExpression<E>	setExpression(ObservableSetValue<E> value) Returns a SetExpression that wraps a ObservableSetValue.
int	size()
abstract ReadOnlyIntegerProperty	sizeProperty() A boolean property that is true, if the set is empty.
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] array)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.beans.value.ObservableObjectValue

get

Methods inherited from interface javafx.beans.value.ObservableValue

addListener, removeListener

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Methods inherited from interface javafx.collections.ObservableSet

addListener, removeListener

Methods inherited from interface java.util.Set

equals, hashCode

Property Detail

size

public abstract ReadOnlyIntegerProperty sizeProperty

A boolean property that is true, if the set is empty.

See Also:

getSize()

empty

public abstract ReadOnlyBooleanProperty emptyProperty

See Also:

isEmpty()

Constructor Detail

SetExpression

public SetExpression()

Method Detail

getValue

public ObservableSet<E> getValue()

Description copied from interface: ObservableValue

Returns the current value of this ObservableValue

Specified by:

getValue in interface ObservableValue<ObservableSet<E>>

Returns:

The current value

setExpression

public static <E> SetExpression<E> setExpression(ObservableSetValue<E> value)

Returns a SetExpression that wraps a ObservableSetValue. If the ObservableSetValue is already a SetExpression, it will be returned. Otherwise a new SetBinding is created that is bound to the ObservableSetValue.

Parameters:

value - The source ObservableSetValue

Returns:

A SetExpression that wraps the ObservableSetValue if necessary

Throws:

java.lang.NullPointerException - if value is null

getSize

public int getSize()

The size of the set

sizeProperty

public abstract ReadOnlyIntegerProperty sizeProperty()

A boolean property that is true, if the set is empty.

See Also:

getSize()

emptyProperty

public abstract ReadOnlyBooleanProperty emptyProperty()

See Also:

isEmpty()

isEqualTo

public BooleanBinding isEqualTo(ObservableSet<?> other)

Creates a new BooleanBinding that holds true if this set is equal to another ObservableSet.

Parameters:

other - the other ObservableSet

Returns:

the new BooleanBinding

Throws:

java.lang.NullPointerException - if other is null

isNotEqualTo

public BooleanBinding isNotEqualTo(ObservableSet<?> other)

Creates a new BooleanBinding that holds true if this set is not equal to another ObservableSet.

Parameters:

other - the other ObservableSet

Returns:

the new BooleanBinding

Throws:

java.lang.NullPointerException - if other is null

isNull

public BooleanBinding isNull()

Creates a new BooleanBinding that holds true if the wrapped set is null.

Returns:

the new BooleanBinding

isNotNull

public BooleanBinding isNotNull()

Creates a new BooleanBinding that holds true if the wrapped set is not null.

Returns:

the new BooleanBinding

asString

public StringBinding asString()

Creates a StringBinding that holds the value of the SetExpression turned into a String. If the value of this SetExpression changes, the value of the StringBinding will be updated automatically.

Returns:

the new StringBinding

size

public int size()

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in interface java.util.Set<E>

isEmpty

public boolean isEmpty()

Gets the value of the property empty.

Specified by:

isEmpty in interface java.util.Collection<E>

Specified by:

isEmpty in interface java.util.Set<E>

contains

public boolean contains(java.lang.Object obj)

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.Set<E>

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in interface java.util.Set<E>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.Set<E>

toArray

public <T> T[] toArray(T[] array)

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.Set<E>

add

public boolean add(E element)

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.Set<E>

remove

public boolean remove(java.lang.Object obj)

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.Set<E>

containsAll

public boolean containsAll(java.util.Collection<?> objects)

Specified by:

containsAll in interface java.util.Collection<E>

Specified by:

containsAll in interface java.util.Set<E>

addAll

public boolean addAll(java.util.Collection<? extends E> elements)

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.Set<E>

removeAll

public boolean removeAll(java.util.Collection<?> objects)

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.Set<E>

retainAll

public boolean retainAll(java.util.Collection<?> objects)

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface java.util.Set<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.Set<E>