Module javafx.base

Package javafx.beans.property

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<E>, ObservableSetValue<E>, ObservableValue<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 inherited from class javafx.beans.binding.SetExpression

empty, size

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)	Indicates whether some other object is "equal to" this one.
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 inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Methods inherited from interface javafx.beans.value.ObservableObjectValue

get

Methods inherited from interface javafx.collections.ObservableSet

addListener, removeListener

Methods inherited from interface javafx.beans.value.ObservableValue

addListener, getValue, removeListener

Methods inherited from interface javafx.beans.property.ReadOnlyProperty

getBean, getName

Methods inherited from interface java.util.Set

of, of, of, of, of, of, of, of, of, of, of, of, spliterator

Methods inherited from class javafx.beans.binding.SetExpression

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

Constructor Detail

ReadOnlySetProperty

public ReadOnlySetProperty()

The constructor of ReadOnlySetProperty.

Method Detail

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)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface Set<E>

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

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.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.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.