Module javafx.base

Class SetExpression<E>

    • Constructor Detail

      • SetExpression

        public SetExpression​()
    • Method Detail

      • setExpression

        public static <E> SetExpression<E> setExpression​(ObservableSetValue<E> value)
        Returns a SetExpression that wraps a ObservableSetValue. If the ObservableSetValue is already a SetExpression, it will be returned. Otherwise a new SetBinding is created that is bound to the ObservableSetValue.
        Type Parameters:
        E - the type of the Set elements
        Parameters:
        value - The source ObservableSetValue
        Returns:
        A SetExpression that wraps the ObservableSetValue if necessary
        Throws:
        NullPointerException - if value is null
      • getSize

        public int getSize​()
        The size of the set
        Returns:
        the size
      • isNull

        public BooleanBinding isNull​()
        Creates a new BooleanBinding that holds true if the wrapped set is null.
        Returns:
        the new BooleanBinding
      • isNotNull

        public BooleanBinding isNotNull​()
        Creates a new BooleanBinding that holds true if the wrapped set is not null.
        Returns:
        the new BooleanBinding
      • asString

        public StringBinding asString​()
        Creates a 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:
        the new StringBinding
      • size

        public int size​()
        Description copied from interface: Set
        Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
        Specified by:
        size in interface Collection<E>
        Specified by:
        size in interface Set<E>
        Returns:
        the number of elements in this set (its cardinality)
      • isEmpty

        public boolean isEmpty​()
        Gets the value of the property empty.
        Specified by:
        isEmpty in interface Collection<E>
        Specified by:
        isEmpty in interface Set<E>
        Property description:
        A boolean property that is true, if the set is empty.
        Returns:
        true if this set contains no elements
      • contains

        public boolean contains​(Object obj)
        Description copied from interface: Set
        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).
        Specified by:
        contains in interface Collection<E>
        Specified by:
        contains in interface Set<E>
        Parameters:
        obj - element whose presence in this set is to be tested
        Returns:
        true if this set contains the specified element
      • iterator

        public Iterator<E> iterator​()
        Description copied from interface: Set
        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).
        Specified by:
        iterator in interface Collection<E>
        Specified by:
        iterator in interface Iterable<E>
        Specified by:
        iterator in interface Set<E>
        Returns:
        an iterator over the elements in this set
      • toArray

        public Object[] toArray​()
        Description copied from interface: Set
        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.

        Specified by:
        toArray in interface Collection<E>
        Specified by:
        toArray in interface Set<E>
        Returns:
        an array containing all the elements in this set
      • toArray

        public <T> T[] toArray​(T[] array)
        Description copied from interface: Set
        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 Set.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().
        Specified by:
        toArray in interface Collection<E>
        Specified by:
        toArray in interface Set<E>
        Type Parameters:
        T - the runtime type of the array to contain the collection
        Parameters:
        array - 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:
        an array containing all the elements in this set
      • add

        public boolean add​(E element)
        Description copied from interface: Set
        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.

        Specified by:
        add in interface Collection<E>
        Specified by:
        add in interface Set<E>
        Parameters:
        element - element to be added to this set
        Returns:
        true if this set did not already contain the specified element
      • remove

        public boolean remove​(Object obj)
        Description copied from interface: Set
        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.)
        Specified by:
        remove in interface Collection<E>
        Specified by:
        remove in interface Set<E>
        Parameters:
        obj - object to be removed from this set, if present
        Returns:
        true if this set contained the specified element
      • containsAll

        public boolean containsAll​(Collection<?> objects)
        Description copied from interface: Set
        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.
        Specified by:
        containsAll in interface Collection<E>
        Specified by:
        containsAll in interface Set<E>
        Parameters:
        objects - collection to be checked for containment in this set
        Returns:
        true if this set contains all of the elements of the specified collection
        See Also:
        Set.contains(Object)
      • addAll

        public boolean addAll​(Collection<? extends E> elements)
        Description copied from interface: Set
        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.
        Specified by:
        addAll in interface Collection<E>
        Specified by:
        addAll in interface Set<E>
        Parameters:
        elements - collection containing elements to be added to this set
        Returns:
        true if this set changed as a result of the call
        See Also:
        Set.add(Object)
      • removeAll

        public boolean removeAll​(Collection<?> objects)
        Description copied from interface: Set
        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.
        Specified by:
        removeAll in interface Collection<E>
        Specified by:
        removeAll in interface Set<E>
        Parameters:
        objects - collection containing elements to be removed from this set
        Returns:
        true if this set changed as a result of the call
        See Also:
        Set.remove(Object), Set.contains(Object)
      • retainAll

        public boolean retainAll​(Collection<?> objects)
        Description copied from interface: Set
        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.
        Specified by:
        retainAll in interface Collection<E>
        Specified by:
        retainAll in interface Set<E>
        Parameters:
        objects - collection containing elements to be retained in this set
        Returns:
        true if this set changed as a result of the call
        See Also:
        Set.remove(Object)
      • clear

        public void clear​()
        Description copied from interface: Set
        Removes all of the elements from this set (optional operation). The set will be empty after this call returns.
        Specified by:
        clear in interface Collection<E>
        Specified by:
        clear in interface Set<E>