Class ReadOnlySetWrapper<E>

java.lang.Object

javafx.beans.binding.SetExpression<E>

javafx.beans.property.ReadOnlySetProperty<E>

javafx.beans.property.SetProperty<E>

javafx.beans.property.SetPropertyBase<E>

javafx.beans.property.SimpleSetProperty<E>

javafx.beans.property.ReadOnlySetWrapper<E>

Type Parameters:

E - the set element type

All Implemented Interfaces:

Iterable<E>, Collection<E>, Set<E>, Observable, Property<ObservableSet<E>>, ReadOnlyProperty<ObservableSet<E>>, ObservableObjectValue<ObservableSet<E>>, ObservableSetValue<E>, ObservableValue<ObservableSet<E>>, WritableObjectValue<ObservableSet<E>>, WritableSetValue<E>, WritableValue<ObservableSet<E>>, ObservableSet<E>

public class ReadOnlySetWrapper<E>
extends SimpleSetProperty<E>

This class provides a convenient class to define read-only properties. It creates two properties that are synchronized. One property is read-only and can be passed to external users. The other property is read- and writable and should be used internally only.

Since:

JavaFX 2.1

Property Summary

Properties declared in class SetPropertyBase

empty, size

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

Constructor Summary

Constructors

Constructor	Description
ReadOnlySetWrapper()	The constructor of ReadOnlySetWrapper
ReadOnlySetWrapper(Object bean, String name)	The constructor of ReadOnlySetWrapper
ReadOnlySetWrapper(Object bean, String name, ObservableSet<E> initialValue)	The constructor of ReadOnlySetWrapper
ReadOnlySetWrapper(ObservableSet<E> initialValue)	The constructor of ReadOnlySetWrapper

Method Summary

Modifier and Type	Method	Description
ReadOnlySetProperty<E>	getReadOnlyProperty()	Returns the readonly property, that is synchronized with this ReadOnlySetWrapper.

Methods declared in class SimpleSetProperty

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 class SetPropertyBase

addListener, addListener, addListener, bind, emptyProperty, fireValueChangedEvent, fireValueChangedEvent, get, invalidated, isBound, removeListener, removeListener, removeListener, set, sizeProperty, toString, unbind

Modifier and Type	Method	Description
void	addListener(InvalidationListener listener)	Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
void	addListener(ChangeListener<? super ObservableSet<E>> listener)	Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
void	addListener(SetChangeListener<? super E> listener)	Add a listener to this observable set.
void	bind(ObservableValue<? extends ObservableSet<E>> newObservable)	Create a unidirection binding for this Property.
ReadOnlyBooleanProperty	emptyProperty()	A boolean property that is true, if the set is empty.
protected void	fireValueChangedEvent()	Sends notifications to all attached InvalidationListeners, ChangeListeners, and SetChangeListener.
protected void	fireValueChangedEvent(SetChangeListener.Change<? extends E> change)	Sends notifications to all attached InvalidationListeners, ChangeListeners, and SetChangeListener.
ObservableSet<E>	get()	Returns the current value of this ObservableObjectValue<T>.
protected void	invalidated()	The method invalidated() can be overridden to receive invalidation notifications.
boolean	isBound()	Can be used to check, if a Property is bound.
void	removeListener(InvalidationListener listener)	Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.
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.
void	removeListener(SetChangeListener<? super E> listener)	Tries to removed a listener from this observable set.
void	set(ObservableSet<E> newValue)	Set the wrapped value.
ReadOnlyIntegerProperty	sizeProperty()	An integer property that represents the size of the set.
String	toString()	Returns a string representation of this SetPropertyBase object.
void	unbind()	Remove the unidirectional binding for this Property.

Methods declared in class SetProperty

bindBidirectional, setValue, unbindBidirectional

Modifier and Type	Method	Description
void	bindBidirectional(Property<ObservableSet<E>> other)	Create a bidirectional binding between this Property and another one.
void	setValue(ObservableSet<E> v)	Set the wrapped value.
void	unbindBidirectional(Property<ObservableSet<E>> other)	Removes a bidirectional binding between this Property and another one.

Methods declared in class ReadOnlySetProperty

bindContent, bindContentBidirectional, equals, hashCode, unbindContent, unbindContentBidirectional

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.
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, getSize, getValue, isEmpty, isEqualTo, isNotEqualTo, isNotNull, isNull, iterator, remove, removeAll, retainAll, setExpression, size, 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)
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()
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

subscribe

Modifier and Type	Method	Description
default Subscription	subscribe(Runnable invalidationSubscriber)	Creates a Subscription on this Observable which calls invalidationSubscriber whenever it becomes invalid.

Methods declared in interface ObservableValue

flatMap, map, orElse, subscribe, subscribe, when

Modifier and Type	Method	Description
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.
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 Set

spliterator

Methods declared in interface WritableValue

getValue

Modifier and Type	Method	Description
ObservableSet<E>	getValue()	Get the wrapped value.

Constructor Details

ReadOnlySetWrapper

public ReadOnlySetWrapper()

The constructor of ReadOnlySetWrapper

ReadOnlySetWrapper

public ReadOnlySetWrapper(ObservableSet<E> initialValue)

The constructor of ReadOnlySetWrapper

Parameters:

initialValue - the initial value of the wrapped value

ReadOnlySetWrapper

public ReadOnlySetWrapper(Object bean,
 String name)

The constructor of ReadOnlySetWrapper

Parameters:

bean - the bean of this ReadOnlySetWrapper

name - the name of this ReadOnlySetWrapper

ReadOnlySetWrapper

public ReadOnlySetWrapper(Object bean,
 String name,
 ObservableSet<E> initialValue)

The constructor of ReadOnlySetWrapper

Parameters:

bean - the bean of this ReadOnlySetWrapper

name - the name of this ReadOnlySetWrapper

initialValue - the initial value of the wrapped value

Method Details

getReadOnlyProperty

public ReadOnlySetProperty<E> getReadOnlyProperty()

Returns the readonly property, that is synchronized with this ReadOnlySetWrapper.

Returns:

the readonly property