Package org.apache.pivot.collections

Class Sequence.Tree.Path

  • All Implemented Interfaces:
    java.lang.Iterable<java.lang.Integer>, Sequence<java.lang.Integer>
    Direct Known Subclasses:
    Sequence.Tree.ImmutablePath
    Enclosing class:
    Sequence.Tree<T>
    public static class Sequence.Tree.Path
extends java.lang.Object
implements Sequence<java.lang.Integer>, java.lang.Iterable<java.lang.Integer>
    An object representing a path to a nested node in nested sequence data.

    • Nested Class Summary

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int add​(java.lang.Integer element)
      Adds an item to the sequence.
      static Sequence.Tree.Path forDepth​(int depth)  
      java.lang.Integer get​(int index)
      Retrieves the item at the given index.
      int getLength()
      Returns the length of the sequence.
      int indexOf​(java.lang.Integer element)
      Returns the index of an item in the sequence.
      void insert​(java.lang.Integer element, int index)
      Inserts an item into the sequence at a specific index.
      java.util.Iterator<java.lang.Integer> iterator()  
      Sequence<java.lang.Integer> remove​(int index, int count)
      Removes one or more items from the sequence.
      int remove​(java.lang.Integer element)
      Removes the first occurrence of the given item from the sequence.
      java.lang.Integer[] toArray()  
      java.lang.String toString()  
      java.lang.Integer update​(int index, java.lang.Integer element)
      Updates the item at the given index.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Method Detail

      • add

        public int add​(java.lang.Integer element)
        Description copied from interface: Sequence
        Adds an item to the sequence.
        Specified by:
        add in interface Sequence<java.lang.Integer>
        Parameters:
        element - The item to be added to the sequence.
        Returns:
        The index at which the item was added, or -1 if the item was not added to the sequence.

      • insert

        public void insert​(java.lang.Integer element,
                   int index)
        Description copied from interface: Sequence
        Inserts an item into the sequence at a specific index.
        Specified by:
        insert in interface Sequence<java.lang.Integer>
        Parameters:
        element - The item to be added to the sequence.
        index - The index at which the item should be inserted. Must be a value between 0 and getLength().

      • update

        public java.lang.Integer update​(int index,
                                java.lang.Integer element)
        Description copied from interface: Sequence
        Updates the item at the given index.
        Specified by:
        update in interface Sequence<java.lang.Integer>
        Parameters:
        index - The index of the item to update.
        element - The item that will replace any existing value at the given index.
        Returns:
        The item that was previously stored at the given index.

      • remove

        @UnsupportedOperation
public int remove​(java.lang.Integer element)
        Description copied from interface: Sequence
        Removes the first occurrence of the given item from the sequence.
        Specified by:
        remove in interface Sequence<java.lang.Integer>
        Parameters:
        element - The item to remove.
        Returns:
        The index of the item that was removed, or -1 if the item could not be found.
        See Also:
        Sequence.remove(int, int)

      • remove

        public Sequence<java.lang.Integer> remove​(int index,
                                          int count)
        Description copied from interface: Sequence
        Removes one or more items from the sequence.
        Specified by:
        remove in interface Sequence<java.lang.Integer>
        Parameters:
        index - The starting index to remove.
        count - The number of items to remove, beginning with index.
        Returns:
        A sequence containing the items that were removed.

      • get

        public java.lang.Integer get​(int index)
        Description copied from interface: Sequence
        Retrieves the item at the given index.
        Specified by:
        get in interface Sequence<java.lang.Integer>
        Parameters:
        index - The index of the item to retrieve.
        Returns:
        The item at this index in the sequence.

      • indexOf

        public int indexOf​(java.lang.Integer element)
        Description copied from interface: Sequence
        Returns the index of an item in the sequence.
        Specified by:
        indexOf in interface Sequence<java.lang.Integer>
        Parameters:
        element - The item to locate.
        Returns:
        The index of first occurrence of the item if it exists in the sequence; -1, otherwise.

      • getLength

        public int getLength()
        Description copied from interface: Sequence
        Returns the length of the sequence.
        Specified by:
        getLength in interface Sequence<java.lang.Integer>
        Returns:
        The number of items in the sequence.

      • iterator

        public java.util.Iterator<java.lang.Integer> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<java.lang.Integer>

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • toArray

        public java.lang.Integer[] toArray()