org.apache.pivot.collections
Class Sequence.Tree.Path

java.lang.Object
  org.apache.pivot.collections.Sequence.Tree.Path

All Implemented Interfaces:

Iterable<Integer>, Sequence<Integer>

Direct Known Subclasses:

Sequence.Tree.ImmutablePath

Enclosing class:

Sequence.Tree<T>

public static class Sequence.Tree.Path
extends Object
implements Sequence<Integer>, Iterable<Integer>

An object representing a path to a nested node in nested sequence data.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence

Sequence.Tree<T>

Constructor Summary

Sequence.Tree.Path()

Sequence.Tree.Path(Integer... elements)

Sequence.Tree.Path(Sequence.Tree.Path path)

Sequence.Tree.Path(Sequence.Tree.Path path, int depth)

Method Summary

int	add(Integer element) Adds an item to the sequence.
static Sequence.Tree.Path	forDepth(int depth)
Integer	get(int index) Retrieves the item at the given index.
int	getLength() Returns the length of the sequence.
int	indexOf(Integer element) Returns the index of an item in the sequence.
void	insert(Integer element, int index) Inserts an item into the sequence at a specific index.
Iterator<Integer>	iterator()
int	remove(Integer element) Removes the first occurrence of the given item from the sequence.
Sequence<Integer>	remove(int index, int count) Removes one or more items from the sequence.
Integer[]	toArray()
String	toString()
Integer	update(int index, 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

Constructor Detail

Sequence.Tree.Path

public Sequence.Tree.Path()

Sequence.Tree.Path

public Sequence.Tree.Path(Integer... elements)

Sequence.Tree.Path

public Sequence.Tree.Path(Sequence.Tree.Path path)

Sequence.Tree.Path

public Sequence.Tree.Path(Sequence.Tree.Path path,
                          int depth)

Method Detail

add

public int add(Integer element)

Description copied from interface: Sequence

Adds an item to the sequence.

Specified by:

add in interface Sequence<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(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<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 Integer update(int index,
                      Integer element)

Description copied from interface: Sequence

Updates the item at the given index.

Specified by:

update in interface Sequence<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

public int remove(Integer element)

Description copied from interface: Sequence

Removes the first occurrence of the given item from the sequence.

Specified by:

remove in interface Sequence<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<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<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 Integer get(int index)

Description copied from interface: Sequence

Retrieves the item at the given index.

Specified by:

get in interface Sequence<Integer>

Parameters:

index - The index of the item to retrieve.

indexOf

public int indexOf(Integer element)

Description copied from interface: Sequence

Returns the index of an item in the sequence.

Specified by:

indexOf in interface Sequence<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<Integer>

Returns:

The number of items in the sequence.

iterator

public Iterator<Integer> iterator()

Specified by:

iterator in interface Iterable<Integer>

toString

public String toString()

Overrides:

toString in class Object

toArray

public Integer[] toArray()

forDepth

public static Sequence.Tree.Path forDepth(int depth)