Class ReadOnlySetPropertyBase<E>

java.lang.Object

javafx.beans.binding.SetExpression<E>

javafx.beans.property.ReadOnlySetProperty<E>

javafx.beans.property.ReadOnlySetPropertyBase<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>

public abstract class ReadOnlySetPropertyBase<E>
extends ReadOnlySetProperty<E>

Base class for all readonly properties wrapping an ObservableSet. This class provides a default implementation to attach listener.

Since:

JavaFX 2.1

See Also:

• ReadOnlySetProperty

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
ReadOnlySetPropertyBase()	Creates a default ReadOnlySetPropertyBase.

Method Summary

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.
protected void	fireValueChangedEvent()	This method needs to be called if the reference to the ObservableSet changes.
protected void	fireValueChangedEvent(SetChangeListener.Change<? extends E> change)	This method needs to be called if the content of the referenced ObservableSet changes.
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.

Methods declared in class ReadOnlySetProperty

bindContent, bindContentBidirectional, equals, hashCode, toString, 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.
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

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 ObservableObjectValue

get

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

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

ReadOnlySetPropertyBase

public ReadOnlySetPropertyBase()

Creates a default ReadOnlySetPropertyBase.

Method Details

addListener

public void addListener(InvalidationListener listener)

Description copied from interface: Observable

Adds an InvalidationListener which will be notified whenever the Observable becomes invalid. If the same listener is added more than once, then it will be notified more than once. That is, no check is made to ensure uniqueness.

Note that the same actual InvalidationListener instance may be safely registered for different Observables.

The Observable stores a strong reference to the listener which will prevent the listener from being garbage collected and may result in a memory leak. It is recommended to either unregister a listener by calling removeListener after use or to use an instance of WeakInvalidationListener avoid this situation.

Parameters:

listener - The listener to register

See Also:

• Observable.removeListener(InvalidationListener)

removeListener

public void removeListener(InvalidationListener listener)

Description copied from interface: Observable

Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.

If the given listener has not been previously registered (i.e. it was never added) then this method call is a no-op. If it had been previously added then it will be removed. If it had been added more than once, then only the first occurrence will be removed.

Parameters:

listener - The listener to remove

See Also:

• Observable.addListener(InvalidationListener)

addListener

public void addListener(ChangeListener<? super ObservableSet<E>> listener)

Description copied from interface: ObservableValue

Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes. If the same listener is added more than once, then it will be notified more than once. That is, no check is made to ensure uniqueness.

Note that the same actual ChangeListener instance may be safely registered for different ObservableValues.

The ObservableValue stores a strong reference to the listener which will prevent the listener from being garbage collected and may result in a memory leak. It is recommended to either unregister a listener by calling removeListener after use or to use an instance of WeakChangeListener avoid this situation.

Parameters:

listener - The listener to register

See Also:

• ObservableValue.removeListener(ChangeListener)

removeListener

public void removeListener(ChangeListener<? super ObservableSet<E>> listener)

Description copied from interface: ObservableValue

Removes the given listener from the list of listeners that are notified whenever the value of the ObservableValue changes.

If the given listener has not been previously registered (i.e. it was never added) then this method call is a no-op. If it had been previously added then it will be removed. If it had been added more than once, then only the first occurrence will be removed.

Parameters:

listener - The listener to remove

See Also:

• ObservableValue.addListener(ChangeListener)

addListener

public void addListener(SetChangeListener<? super E> listener)

Description copied from interface: ObservableSet

Add a listener to this observable set.

Parameters:

listener - the listener for listening to the set changes

removeListener

public void removeListener(SetChangeListener<? super E> listener)

Description copied from interface: ObservableSet

Tries to removed a listener from this observable set. If the listener is not attached to this list, nothing happens.

Parameters:

listener - a listener to remove

fireValueChangedEvent

protected void fireValueChangedEvent()

This method needs to be called if the reference to the ObservableSet changes. It sends notifications to all attached InvalidationListeners, ChangeListeners, and SetChangeListener. This method needs to be called, if the value of this property changes.

fireValueChangedEvent

protected void fireValueChangedEvent(SetChangeListener.Change<? extends E> change)

This method needs to be called if the content of the referenced ObservableSet changes. Sends notifications to all attached InvalidationListeners, ChangeListeners, and SetChangeListener. This method is called when the content of the list changes.

Parameters:

change - the change that needs to be propagated