Module javafx.base

Class ListExpression<E>

    • Constructor Detail

      • ListExpression

        public ListExpression​()
    • Method Detail

      • listExpression

        public static <E> ListExpression<E> listExpression​(ObservableListValue<E> value)
        Returns a ListExpression that wraps a ObservableListValue. If the ObservableListValue is already a ListExpression, it will be returned. Otherwise a new ListBinding is created that is bound to the ObservableListValue.
        Type Parameters:
        E - the type of the wrapped List
        Parameters:
        value - The source ObservableListValue
        Returns:
        A ListExpression that wraps the ObservableListValue if necessary
        Throws:
        NullPointerException - if value is null
      • getSize

        public int getSize​()
        The size of the list
        Returns:
        the size
      • valueAt

        public ObjectBinding<E> valueAt​(int index)
        Creates a new ObjectBinding that contains the element at the specified position. If index points behind the list, the ObjectBinding contains null.
        Parameters:
        index - the index of the element
        Returns:
        the ObjectBinding
        Throws:
        IllegalArgumentException - if index < 0
      • valueAt

        public ObjectBinding<E> valueAt​(ObservableIntegerValue index)
        Creates a new ObjectBinding that contains the element at the specified position. If index points outside of the list, the ObjectBinding contains null.
        Parameters:
        index - the index of the element
        Returns:
        the ObjectBinding
        Throws:
        NullPointerException - if index is null
      • isNull

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

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

        public StringBinding asString​()
        Creates a StringBinding that holds the value of the ListExpression turned into a String. If the value of this ListExpression changes, the value of the StringBinding will be updated automatically.
        Returns:
        the new StringBinding
      • size

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

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

        public boolean contains​(Object obj)
        Description copied from interface: List
        Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that Objects.equals(o, e).
        Specified by:
        contains in interface Collection<E>
        Specified by:
        contains in interface List<E>
        Parameters:
        obj - element whose presence in this list is to be tested
        Returns:
        true if this list contains the specified element
      • iterator

        public Iterator<E> iterator​()
        Description copied from interface: List
        Returns an iterator over the elements in this list in proper sequence.
        Specified by:
        iterator in interface Collection<E>
        Specified by:
        iterator in interface Iterable<E>
        Specified by:
        iterator in interface List<E>
        Returns:
        an iterator over the elements in this list in proper sequence
      • toArray

        public Object[] toArray​()
        Description copied from interface: List
        Returns an array containing all of the elements in this list in proper sequence (from first to last element).

        The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array even if this list 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 List<E>
        Returns:
        an array containing all of the elements in this list in proper sequence
        See Also:
        Arrays.asList(Object[])
      • toArray

        public <T> T[] toArray​(T[] array)
        Description copied from interface: List
        Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the list 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 list.

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

        Like the List.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 list known to contain only strings. The following code can be used to dump the list 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 List<E>
        Type Parameters:
        T - the runtime type of the array to contain the collection
        Parameters:
        array - the array into which the elements of this list 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 the elements of this list
      • add

        public boolean add​(E element)
        Description copied from interface: List
        Appends the specified element to the end of this list (optional operation).

        Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added.

        Specified by:
        add in interface Collection<E>
        Specified by:
        add in interface List<E>
        Parameters:
        element - element to be appended to this list
        Returns:
        true (as specified by Collection.add(E))
      • remove

        public boolean remove​(Object obj)
        Description copied from interface: List
        Removes the first occurrence of the specified element from this list, if it is present (optional operation). If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that Objects.equals(o, get(i)) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).
        Specified by:
        remove in interface Collection<E>
        Specified by:
        remove in interface List<E>
        Parameters:
        obj - element to be removed from this list, if present
        Returns:
        true if this list contained the specified element
      • containsAll

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

        public boolean addAll​(Collection<? extends E> elements)
        Description copied from interface: List
        Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
        Specified by:
        addAll in interface Collection<E>
        Specified by:
        addAll in interface List<E>
        Parameters:
        elements - collection containing elements to be added to this list
        Returns:
        true if this list changed as a result of the call
        See Also:
        List.add(Object)
      • addAll

        public boolean addAll​(int i,
                              Collection<? extends E> elements)
        Description copied from interface: List
        Inserts all of the elements in the specified collection into this list at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
        Specified by:
        addAll in interface List<E>
        Parameters:
        i - index at which to insert the first element from the specified collection
        elements - collection containing elements to be added to this list
        Returns:
        true if this list changed as a result of the call
      • removeAll

        public boolean removeAll​(Collection<?> objects)
        Description copied from interface: List
        Removes from this list all of its elements that are contained in the specified collection (optional operation).
        Specified by:
        removeAll in interface Collection<E>
        Specified by:
        removeAll in interface List<E>
        Parameters:
        objects - collection containing elements to be removed from this list
        Returns:
        true if this list changed as a result of the call
        See Also:
        List.remove(Object), List.contains(Object)
      • retainAll

        public boolean retainAll​(Collection<?> objects)
        Description copied from interface: List
        Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all of its elements that are not contained in the specified collection.
        Specified by:
        retainAll in interface Collection<E>
        Specified by:
        retainAll in interface List<E>
        Parameters:
        objects - collection containing elements to be retained in this list
        Returns:
        true if this list changed as a result of the call
        See Also:
        List.remove(Object), List.contains(Object)
      • clear

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

        public E get​(int i)
        Description copied from interface: List
        Returns the element at the specified position in this list.
        Specified by:
        get in interface List<E>
        Parameters:
        i - index of the element to return
        Returns:
        the element at the specified position in this list
      • set

        public E set​(int i,
                     E element)
        Description copied from interface: List
        Replaces the element at the specified position in this list with the specified element (optional operation).
        Specified by:
        set in interface List<E>
        Parameters:
        i - index of the element to replace
        element - element to be stored at the specified position
        Returns:
        the element previously at the specified position
      • add

        public void add​(int i,
                        E element)
        Description copied from interface: List
        Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
        Specified by:
        add in interface List<E>
        Parameters:
        i - index at which the specified element is to be inserted
        element - element to be inserted
      • remove

        public E remove​(int i)
        Description copied from interface: List
        Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.
        Specified by:
        remove in interface List<E>
        Parameters:
        i - the index of the element to be removed
        Returns:
        the element previously at the specified position
      • indexOf

        public int indexOf​(Object obj)
        Description copied from interface: List
        Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.
        Specified by:
        indexOf in interface List<E>
        Parameters:
        obj - element to search for
        Returns:
        the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element
      • lastIndexOf

        public int lastIndexOf​(Object obj)
        Description copied from interface: List
        Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.
        Specified by:
        lastIndexOf in interface List<E>
        Parameters:
        obj - element to search for
        Returns:
        the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element
      • listIterator

        public ListIterator<E> listIterator​()
        Description copied from interface: List
        Returns a list iterator over the elements in this list (in proper sequence).
        Specified by:
        listIterator in interface List<E>
        Returns:
        a list iterator over the elements in this list (in proper sequence)
      • listIterator

        public ListIterator<E> listIterator​(int i)
        Description copied from interface: List
        Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first element that would be returned by an initial call to next. An initial call to previous would return the element with the specified index minus one.
        Specified by:
        listIterator in interface List<E>
        Parameters:
        i - index of the first element to be returned from the list iterator (by a call to next)
        Returns:
        a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list
      • subList

        public List<E> subList​(int from,
                               int to)
        Description copied from interface: List
        Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list.

        This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:

        
              list.subList(from, to).clear();
         
        Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList.

        The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

        Specified by:
        subList in interface List<E>
        Parameters:
        from - low endpoint (inclusive) of the subList
        to - high endpoint (exclusive) of the subList
        Returns:
        a view of the specified range within this list
      • addAll

        public boolean addAll​(E... elements)
        Description copied from interface: ObservableList
        A convenience method for var-arg addition of elements.
        Specified by:
        addAll in interface ObservableList<E>
        Parameters:
        elements - the elements to add
        Returns:
        true (as specified by Collection.add(E))
      • setAll

        public boolean setAll​(E... elements)
        Description copied from interface: ObservableList
        Clears the ObservableList and adds all the elements passed as var-args.
        Specified by:
        setAll in interface ObservableList<E>
        Parameters:
        elements - the elements to set
        Returns:
        true (as specified by Collection.add(E))
      • setAll

        public boolean setAll​(Collection<? extends E> elements)
        Description copied from interface: ObservableList
        Clears the ObservableList and adds all elements from the collection.
        Specified by:
        setAll in interface ObservableList<E>
        Parameters:
        elements - the collection with elements that will be added to this observableArrayList
        Returns:
        true (as specified by Collection.add(E))
      • removeAll

        public boolean removeAll​(E... elements)
        Description copied from interface: ObservableList
        A convenience method for var-arg usage of the removeAll method.
        Specified by:
        removeAll in interface ObservableList<E>
        Parameters:
        elements - the elements to be removed
        Returns:
        true if list changed as a result of this call
      • retainAll

        public boolean retainAll​(E... elements)
        Description copied from interface: ObservableList
        A convenience method for var-arg usage of the retainAll method.
        Specified by:
        retainAll in interface ObservableList<E>
        Parameters:
        elements - the elements to be retained
        Returns:
        true if list changed as a result of this call
      • remove

        public void remove​(int from,
                           int to)
        Description copied from interface: ObservableList
        A simplified way of calling sublist(from, to).clear(). As this is a common operation, ObservableList has this method for convenient usage.
        Specified by:
        remove in interface ObservableList<E>
        Parameters:
        from - the start of the range to remove (inclusive)
        to - the end of the range to remove (exclusive)