Class ReadOnlySetProperty<E>

java.lang.Object

javafx.beans.binding.SetExpression<E>

javafx.beans.property.ReadOnlySetProperty<E>

Type Parameters:

E - the type of the Set elements

All Implemented Interfaces:

Iterable<E>, Collection<E>, Set<E>, Observable, ReadOnlyProperty<ObservableSet<E>>, ObservableObjectValue<ObservableSet<E>>, ObservableSetValue<E>, ObservableValue<ObservableSet<E>>, ObservableSet<E>

Direct Known Subclasses:

ReadOnlySetPropertyBase, SetProperty

public abstract class ReadOnlySetProperty<E>
extends SetExpression<E>
implements ReadOnlyProperty<ObservableSet<E>>

Superclass for all readonly properties wrapping an ObservableSet.

Since:

JavaFX 2.1

See Also:

• ObservableSet
• ObservableSetValue
• SetExpression
• ReadOnlyProperty

Property Summary

Properties declared in class SetExpression

empty, size

Type	Property	Description
abstract ReadOnlyBooleanProperty	empty	A boolean property that is true, if the set is empty.
abstract ReadOnlyIntegerProperty	size	An integer property that represents the size of the set.

Constructor Summary

Constructors

Constructor	Description
ReadOnlySetProperty()	The constructor of ReadOnlySetProperty.

Method Summary

Modifier and Type	Method	Description
void	bindContent(ObservableSet<E> set)	Creates a content binding between the ObservableSet, that is wrapped in this ReadOnlySetProperty, and another ObservableSet.
void	bindContentBidirectional(ObservableSet<E> set)	Creates a bidirectional content binding of the ObservableSet, that is wrapped in this ReadOnlySetProperty, and another ObservableSet.
boolean	equals(Object obj)
int	hashCode()	Returns a hash code for this ReadOnlySetProperty object.
String	toString()	Returns a string representation of this ReadOnlySetProperty object.
void	unbindContent(Object object)	Deletes a content binding between the ObservableSet, that is wrapped in this ReadOnlySetProperty, and another Object.
void	unbindContentBidirectional(Object object)	Deletes a bidirectional content binding between the ObservableSet, that is wrapped in this ReadOnlySetProperty, and another Object.

Methods declared in class SetExpression

add, addAll, asString, clear, contains, containsAll, emptyProperty, getSize, getValue, isEmpty, isEqualTo, isNotEqualTo, isNotNull, isNull, iterator, remove, removeAll, retainAll, setExpression, size, sizeProperty, toArray, toArray

Modifier and Type	Method	Description
boolean	add(E element)
boolean	addAll(Collection<? extends E> elements)
StringBinding	asString()	Creates a StringBinding that holds the value of the SetExpression turned into a String.
void	clear()
boolean	contains(Object obj)
boolean	containsAll(Collection<?> objects)
abstract ReadOnlyBooleanProperty	emptyProperty()	A boolean property that is true, if the set is empty.
int	getSize()	The size of the set
ObservableSet<E>	getValue()	Returns the current value of this ObservableValue
boolean	isEmpty()	Gets the value of the empty property.
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.
Iterator<E>	iterator()
boolean	remove(Object obj)
boolean	removeAll(Collection<?> objects)
boolean	retainAll(Collection<?> objects)
static <E> SetExpression<E>	setExpression(ObservableSetValue<E> value)	Returns a SetExpression that wraps a ObservableSetValue.
int	size()
abstract ReadOnlyIntegerProperty	sizeProperty()	An integer property that represents the size of the set.
Object[]	toArray()
<T> T[]	toArray(T[] array)

Methods declared in class Object

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

Methods declared in interface Collection

parallelStream, removeIf, stream, toArray

Methods declared in interface Iterable

forEach

Methods declared in interface Observable

addListener, removeListener, subscribe

Modifier and Type	Method	Description
void	addListener(InvalidationListener listener)	Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
void	removeListener(InvalidationListener listener)	Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.
default Subscription	subscribe(Runnable invalidationSubscriber)	Creates a Subscription on this Observable which calls invalidationSubscriber whenever it becomes invalid.

Methods declared in interface ObservableObjectValue

get

Modifier and Type	Method	Description
ObservableSet<E>	get()	Returns the current value of this ObservableObjectValue<T>.

Methods declared in interface ObservableSet

addListener, removeListener

Modifier and Type	Method	Description
void	addListener(SetChangeListener<? super E> listener)	Add a listener to this observable set.
void	removeListener(SetChangeListener<? super E> listener)	Tries to removed a listener from this observable set.

Methods declared in interface ObservableValue

addListener, flatMap, map, orElse, removeListener, subscribe, subscribe, when

Modifier and Type	Method	Description
void	addListener(ChangeListener<? super ObservableSet<E>> listener)	Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
default <U> ObservableValue<U>	flatMap(Function<? super ObservableSet<E>, ? extends ObservableValue<? extends U>> mapper)	Returns an ObservableValue that holds the value of an ObservableValue produced by applying the given mapping function on this value.
default <U> ObservableValue<U>	map(Function<? super ObservableSet<E>, ? extends U> mapper)	Returns an ObservableValue that holds the result of applying the given mapping function on this value.
default ObservableValue<ObservableSet<E>>	orElse(ObservableSet<E> constant)	Returns an ObservableValue that holds this value, or the given constant if it is null.
void	removeListener(ChangeListener<? super ObservableSet<E>> listener)	Removes the given listener from the list of listeners that are notified whenever the value of the ObservableValue changes.
default Subscription	subscribe(BiConsumer<? super ObservableSet<E>, ? super ObservableSet<E>> changeSubscriber)	Creates a Subscription on this ObservableValue which calls the given changeSubscriber with the old and new value whenever its value changes.
default Subscription	subscribe(Consumer<? super ObservableSet<E>> valueSubscriber)	Creates a Subscription on this ObservableValue which immediately provides the current value to the given valueSubscriber, followed by any subsequent values whenever its value changes.
default ObservableValue<ObservableSet<E>>	when(ObservableValue<Boolean> condition)	Returns an ObservableValue that holds this value and is updated only when condition holds true.

Methods declared in interface ReadOnlyProperty

getBean, getName

Modifier and Type	Method	Description
Object	getBean()	Returns the Object that contains this property.
String	getName()	Returns the name of this property.

Methods declared in interface Set

spliterator

Constructor Details

ReadOnlySetProperty

public ReadOnlySetProperty()

The constructor of ReadOnlySetProperty.

Method Details

bindContentBidirectional

public void bindContentBidirectional(ObservableSet<E> set)

Creates a bidirectional content binding of the ObservableSet, that is wrapped in this ReadOnlySetProperty, and another ObservableSet.

A bidirectional content binding ensures that the content of two ObservableSets is the same. If the content of one of the sets changes, the other one will be updated automatically.

Parameters:

set - the ObservableSet this property should be bound to

Throws:

NullPointerException - if set is null

IllegalArgumentException - if set is the same set that this ReadOnlySetProperty points to

unbindContentBidirectional

public void unbindContentBidirectional(Object object)

Deletes a bidirectional content binding between the ObservableSet, that is wrapped in this ReadOnlySetProperty, and another Object.

Parameters:

object - the Object to which the bidirectional binding should be removed

Throws:

NullPointerException - if object is null

IllegalArgumentException - if object is the same set that this ReadOnlySetProperty points to

bindContent

public void bindContent(ObservableSet<E> set)

Creates a content binding between the ObservableSet, that is wrapped in this ReadOnlySetProperty, and another ObservableSet.

A content binding ensures that the content of the wrapped ObservableSets is the same as that of the other set. If the content of the other set changes, the wrapped set will be updated automatically. Once the wrapped set is bound to another set, you must not change it directly.

Parameters:

set - the ObservableSet this property should be bound to

Throws:

NullPointerException - if set is null

IllegalArgumentException - if set is the same set that this ReadOnlySetProperty points to

unbindContent

public void unbindContent(Object object)

Deletes a content binding between the ObservableSet, that is wrapped in this ReadOnlySetProperty, and another Object.

Parameters:

object - the Object to which the binding should be removed

Throws:

NullPointerException - if object is null

IllegalArgumentException - if object is the same set that this ReadOnlySetProperty points to

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface Set<E>

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns a hash code for this ReadOnlySetProperty object.

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface Set<E>

Overrides:

hashCode in class Object

Returns:

a hash code for this ReadOnlySetProperty object.

toString

public String toString()

Returns a string representation of this ReadOnlySetProperty object.

Overrides:

toString in class Object

Returns:

a string representation of this ReadOnlySetProperty object.