JavaFX 24 · javafx.beans.binding.SetExpression · APIdia, the JavaDoc alternative

Access	Constructor and Description
public	SetExpression() Creates a default `SetExpression`.

Method Summary

Modifier and Type	Method and Description
public boolean	add(E element to be added to this set element) Implements java.util.Set.add. Adds the specified element to this set if it is not already present (optional operation).
public boolean	addAll(Collection<? extends E> collection containing elements to be added to this set elements) Implements java.util.Set.addAll. Adds all of the elements in the specified collection to this set if they're not already present (optional operation).
public StringBinding	Returns: the new `StringBinding` asString() Creates a `javafx.beans.binding.StringBinding` that holds the value of the `SetExpression` turned into a `String`.
public void	clear() Implements java.util.Set.clear. Removes all of the elements from this set (optional operation).
public boolean	contains(Object element whose presence in this set is to be tested obj) Implements java.util.Set.contains. Returns `true` if this set contains the specified element.
public boolean	containsAll(Collection<?> collection to be checked for containment in this set objects) Implements java.util.Set.containsAll. Returns `true` if this set contains all of the elements of the specified collection.
public abstract ReadOnlyBooleanProperty	Returns: the `ReadOnlyBooleanProperty` emptyProperty() A boolean property that is `true`, if the set is empty.
private ObservableSet<E>	getNonNull()
public int	Returns: the size getSize() The size of the set
public ObservableSet<E>	getValue() Implements javafx.beans.value.ObservableValue.getValue. Returns the current value of this `ObservableValue`
public boolean	isEmpty() Implements java.util.Set.isEmpty. Returns `true` if this set contains no elements.
public BooleanBinding	Returns: the new `BooleanBinding` isEqualTo(final ObservableSet<?> the other `ObservableSet` other) Creates a new `BooleanBinding` that holds `true` if this set is equal to another `javafx.collections.ObservableSet`.
public BooleanBinding	Returns: the new `BooleanBinding` isNotEqualTo(final ObservableSet<?> the other `ObservableSet` other) Creates a new `BooleanBinding` that holds `true` if this set is not equal to another `javafx.collections.ObservableSet`.
public BooleanBinding	Returns: the new `BooleanBinding` isNotNull() Creates a new `BooleanBinding` that holds `true` if the wrapped set is not `null`.
public BooleanBinding	Returns: the new `BooleanBinding` isNull() Creates a new `BooleanBinding` that holds `true` if the wrapped set is `null`.
public Iterator<E>	iterator() Implements java.util.Set.iterator. Returns an iterator over the elements in this set.
public boolean	remove(Object object to be removed from this set, if present obj) Implements java.util.Set.remove. Removes the specified element from this set if it is present (optional operation).
public boolean	removeAll(Collection<?> collection containing elements to be removed from this set objects) Implements java.util.Set.removeAll. Removes from this set all of its elements that are contained in the specified collection (optional operation).
public boolean	retainAll(Collection<?> collection containing elements to be retained in this set objects) Implements java.util.Set.retainAll. Retains only the elements in this set that are contained in the specified collection (optional operation).
public static < the type of the `Set` elements E> SetExpression<E>	Returns: A `SetExpression` that wraps the `ObservableSetValue` if necessary setExpression(final ObservableSetValue<E> The source `ObservableSetValue` value) Returns a `SetExpression` that wraps a `javafx.beans.value.ObservableSetValue`.
public int	size() Implements java.util.Set.size. Returns the number of elements in this set (its cardinality).
public abstract ReadOnlyIntegerProperty	Returns: the property sizeProperty() An integer property that represents the size of the set.
public Object[]	toArray() Implements java.util.Set.toArray. Returns an array containing all of the elements in this set.
public <T> T[]	toArray(T[] the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose. array) Implements java.util.Set.toArray. Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

SetExpression	back to summary
public SetExpression() Creates a default `SetExpression`.

Method Detail

add back to summary

add	back to summary
public boolean add(E element) Implements java.util.Set.add. Doc from java.util.Set.add. Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element `e` to this set if the set contains no element `e2` such that `Objects.equals(e, e2)`. If this set already contains the element, the call leaves the set unchanged and returns `false`. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements. The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including `null`, and throw an exception, as described in the specification for `Collection.add`. Individual set implementations should clearly document any restrictions on the elements that they may contain. Parameters element:E element to be added to this set Returns:boolean `true` if this set did not already contain the specified element Annotations @Override

public boolean add(E element)

Implements java.util.Set.add.

Doc from java.util.Set.add.

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element e to this set if the set contains no element e2 such that Objects.equals(e, e2). If this set already contains the element, the call leaves the set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throw an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the elements that they may contain.

Parameters

element:E: element to be added to this set

Returns:boolean

true if this set did not already contain the specified element

Annotations

@Override

addAll back to summary

addAll	back to summary
public boolean addAll(Collection<? extends E> elements) Implements java.util.Set.addAll. Doc from java.util.Set.addAll. Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the `addAll` operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. Parameters elements:Collection<? extends E> collection containing elements to be added to this set Returns:boolean `true` if this set changed as a result of the call Annotations @Override

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

Implements java.util.Set.addAll.

Doc from java.util.Set.addAll.

Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Parameters

elements:Collection<? extends E>: collection containing elements to be added to this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

asString back to summary

asString	back to summary
public StringBinding asString() Creates a `javafx.beans.binding.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:StringBinding the new `StringBinding`

public StringBinding asString()

Creates a javafx.beans.binding.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:StringBinding: the new StringBinding

clear	back to summary
public void clear() Implements java.util.Set.clear. Doc from java.util.Set.clear. Removes all of the elements from this set (optional operation). The set will be empty after this call returns. Annotations @Override

clear

back to summary

public void clear()

Implements java.util.Set.clear.

Doc from java.util.Set.clear.

Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

Annotations

@Override

contains back to summary

contains	back to summary
public boolean contains(Object obj) Implements java.util.Set.contains. Doc from java.util.Set.contains. Returns `true` if this set contains the specified element. More formally, returns `true` if and only if this set contains an element `e` such that `Objects.equals(o, e)`. Parameters obj:Object element whose presence in this set is to be tested Returns:boolean `true` if this set contains the specified element Annotations @Override

public boolean contains(Object obj)

Implements java.util.Set.contains.

Doc from java.util.Set.contains.

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that Objects.equals(o, e).

Parameters

obj:Object: element whose presence in this set is to be tested

Returns:boolean

true if this set contains the specified element

Annotations

@Override

containsAll back to summary

containsAll	back to summary
public boolean containsAll(Collection<?> objects) Implements java.util.Set.containsAll. Doc from java.util.Set.containsAll. Returns `true` if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns `true` if it is a subset of this set. Parameters objects:Collection<?> collection to be checked for containment in this set Returns:boolean `true` if this set contains all of the elements of the specified collection Annotations @Override

public boolean containsAll(Collection<?> objects)

Implements java.util.Set.containsAll.

Doc from java.util.Set.containsAll.

Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.

Parameters

objects:Collection<?>: collection to be checked for containment in this set

Returns:boolean

true if this set contains all of the elements of the specified collection

Annotations

@Override

emptyProperty back to summary

emptyProperty	back to summary
public abstract ReadOnlyBooleanProperty emptyProperty() A boolean property that is `true`, if the set is empty. Returns:ReadOnlyBooleanProperty the `ReadOnlyBooleanProperty`

public abstract ReadOnlyBooleanProperty emptyProperty()

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

Returns:ReadOnlyBooleanProperty: the ReadOnlyBooleanProperty

getNonNull	back to summary
private ObservableSet<E> getNonNull()

getSize	back to summary
public int getSize() The size of the set Returns:int the size

getSize

back to summary

public int getSize()

The size of the set

Returns:int: the size

getValue back to summary

getValue	back to summary
public ObservableSet<E> getValue() Implements javafx.beans.value.ObservableValue.getValue. Doc from javafx.beans.value.ObservableValue.getValue. Returns the current value of this `ObservableValue` Returns:ObservableSet<E> The current value Annotations @Override

public ObservableSet<E> getValue()

Implements javafx.beans.value.ObservableValue.getValue.

Doc from javafx.beans.value.ObservableValue.getValue.

Returns the current value of this ObservableValue

Returns:ObservableSet<E>

The current value

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements java.util.Set.isEmpty. Doc from java.util.Set.isEmpty. Returns `true` if this set contains no elements. Returns:boolean `true` if this set contains no elements Annotations @Override

public boolean isEmpty()

Implements java.util.Set.isEmpty.

Doc from java.util.Set.isEmpty.

Returns true if this set contains no elements.

Returns:boolean

true if this set contains no elements

Annotations

@Override

isEqualTo back to summary

isEqualTo	back to summary
public BooleanBinding isEqualTo(final ObservableSet<?> other) Creates a new `BooleanBinding` that holds `true` if this set is equal to another `javafx.collections.ObservableSet`. Parameters other:ObservableSet<?> the other `ObservableSet` Returns:BooleanBinding the new `BooleanBinding` Exceptions NullPointerException: if `other` is `null`

public BooleanBinding isEqualTo(final ObservableSet<?> other)

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

Parameters

other:ObservableSet<?>: the other ObservableSet

Returns:BooleanBinding

the new BooleanBinding

Exceptions

NullPointerException:: if other is null

isNotEqualTo back to summary

isNotEqualTo	back to summary
public BooleanBinding isNotEqualTo(final ObservableSet<?> other) Creates a new `BooleanBinding` that holds `true` if this set is not equal to another `javafx.collections.ObservableSet`. Parameters other:ObservableSet<?> the other `ObservableSet` Returns:BooleanBinding the new `BooleanBinding` Exceptions NullPointerException: if `other` is `null`

public BooleanBinding isNotEqualTo(final ObservableSet<?> other)

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

Parameters

other:ObservableSet<?>: the other ObservableSet

Returns:BooleanBinding

the new BooleanBinding

Exceptions

NullPointerException:: if other is null

isNotNull back to summary

isNotNull	back to summary
public BooleanBinding isNotNull() Creates a new `BooleanBinding` that holds `true` if the wrapped set is not `null`. Returns:BooleanBinding the new `BooleanBinding`

public BooleanBinding isNotNull()

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

Returns:BooleanBinding: the new BooleanBinding

isNull back to summary

isNull	back to summary
public BooleanBinding isNull() Creates a new `BooleanBinding` that holds `true` if the wrapped set is `null`. Returns:BooleanBinding the new `BooleanBinding`

public BooleanBinding isNull()

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

Returns:BooleanBinding: the new BooleanBinding

iterator	back to summary
public Iterator<E> iterator() Implements java.util.Set.iterator. Doc from java.util.Set.iterator. Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee). Returns:Iterator<E> an iterator over the elements in this set Annotations @Override

iterator

back to summary

public Iterator<E> iterator()

Implements java.util.Set.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Returns:Iterator<E>

an iterator over the elements in this set

Annotations

@Override

remove back to summary

remove	back to summary
public boolean remove(Object obj) Implements java.util.Set.remove. Doc from java.util.Set.remove. Removes the specified element from this set if it is present (optional operation). More formally, removes an element `e` such that `Objects.equals(o, e)`, if this set contains such an element. Returns `true` if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.) Parameters obj:Object object to be removed from this set, if present Returns:boolean `true` if this set contained the specified element Annotations @Override

public boolean remove(Object obj)

Implements java.util.Set.remove.

Doc from java.util.Set.remove.

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Parameters

obj:Object: object to be removed from this set, if present

Returns:boolean

true if this set contained the specified element

Annotations

@Override

removeAll back to summary

removeAll	back to summary
public boolean removeAll(Collection<?> objects) Implements java.util.Set.removeAll. Doc from java.util.Set.removeAll. Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets. Parameters objects:Collection<?> collection containing elements to be removed from this set Returns:boolean `true` if this set changed as a result of the call Annotations @Override

public boolean removeAll(Collection<?> objects)

Implements java.util.Set.removeAll.

Doc from java.util.Set.removeAll.

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

Parameters

objects:Collection<?>: collection containing elements to be removed from this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

retainAll back to summary

retainAll	back to summary
public boolean retainAll(Collection<?> objects) Implements java.util.Set.retainAll. Doc from java.util.Set.retainAll. Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets. Parameters objects:Collection<?> collection containing elements to be retained in this set Returns:boolean `true` if this set changed as a result of the call Annotations @Override

public boolean retainAll(Collection<?> objects)

Implements java.util.Set.retainAll.

Doc from java.util.Set.retainAll.

Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.

Parameters

objects:Collection<?>: collection containing elements to be retained in this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

setExpression back to summary

setExpression	back to summary
public static <E> SetExpression<E> setExpression(final ObservableSetValue<E> value) Returns a `SetExpression` that wraps a `javafx.beans.value.ObservableSetValue`. If the `ObservableSetValue` is already a `SetExpression`, it will be returned. Otherwise a new `javafx.beans.binding.SetBinding` is created that is bound to the `ObservableSetValue`. Parameters <E> the type of the `Set` elements value:ObservableSetValue<E> The source `ObservableSetValue` Returns:SetExpression<E> A `SetExpression` that wraps the `ObservableSetValue` if necessary Exceptions NullPointerException: if `value` is `null`

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

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

Parameters

<E>: the type of the Set elements
value:ObservableSetValue<E>: The source ObservableSetValue

Returns:SetExpression<E>

A SetExpression that wraps the ObservableSetValue if necessary

Exceptions

NullPointerException:: if value is null

size back to summary

size	back to summary
public int size() Implements java.util.Set.size. Doc from java.util.Set.size. Returns the number of elements in this set (its cardinality). If this set contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of elements in this set (its cardinality) Annotations @Override

public int size()

Implements java.util.Set.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of elements in this set (its cardinality)

Annotations

@Override

sizeProperty	back to summary
public abstract ReadOnlyIntegerProperty sizeProperty() An integer property that represents the size of the set. Returns:ReadOnlyIntegerProperty the property

sizeProperty

back to summary

public abstract ReadOnlyIntegerProperty sizeProperty()

An integer property that represents the size of the set.

Returns:ReadOnlyIntegerProperty: the property

toArray	back to summary
public Object[] toArray() Implements java.util.Set.toArray. Doc from java.util.Set.toArray. Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an array). The caller is thus free to modify the returned array. This method acts as bridge between array-based and collection-based APIs. Returns:Object[] an array containing all the elements in this set Annotations @Override

toArray

back to summary

public Object[] toArray()

Implements java.util.Set.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Returns:Object[]

an array containing all the elements in this set

Annotations

@Override

toArray back to summary

toArray	back to summary
public <T> T[] toArray(T[] array) Implements java.util.Set.toArray. Doc from java.util.Set.toArray. Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. If the set fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this set. If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to `null`. (This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.) If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. Like the `toArray()` method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs. Suppose `x` is a set known to contain only strings. The following code can be used to dump the set into a newly allocated array of `String`: String[] y = x.toArray(new String[0]); Note that `toArray(new Object[0])` is identical in function to `toArray()`. Parameters <T> Doc from java.util.Collection.toArray. the component type of the array to contain the collection array:T[] the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose. Returns:T[] an array containing all the elements in this set Annotations @Override

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

Implements java.util.Set.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. If the set fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this set.

If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to null. (This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.)

If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a set known to contain only strings. The following code can be used to dump the set into a newly allocated array of String:

    String[] y = x.toArray(new String[0]);

Note that toArray(new Object[0]) is identical in function to toArray().

Parameters

<T>: Doc from java.util.Collection.toArray. the component type of the array to contain the collection
array:T[]: the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:T[]

an array containing all the elements in this set

Annotations

@Override

public abstract Class SetExpression<E>

Constructor Summary

Method Summary

Constructor Detail

Method Detail