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

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

All Implemented Interfaces:

Iterable<Integer>, Sequence<Integer>

Enclosing class:

Sequence.Tree<T>

public static class Sequence.Tree.ImmutablePath
extends Sequence.Tree.Path

Class representing an immutable path.

Nested Class Summary

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

Sequence.Tree<T>

Constructor Summary

Sequence.Tree.ImmutablePath(Integer... elements)

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

Method Summary

int	add(Integer element) Adds an item to the sequence.
void	insert(Integer element, int index) Inserts an item into the sequence at a specific index.
Sequence<Integer>	remove(int index, int count) Removes one or more items from the sequence.
Integer	update(int index, Integer element) Updates the item at the given index.

Methods inherited from class org.apache.pivot.collections.Sequence.Tree.Path

forDepth, get, getLength, indexOf, iterator, remove, toArray, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Sequence.Tree.ImmutablePath

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

Sequence.Tree.ImmutablePath

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

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>

Overrides:

add in class Sequence.Tree.Path

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>

Overrides:

insert in class Sequence.Tree.Path

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>

Overrides:

update in class Sequence.Tree.Path

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 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>

Overrides:

remove in class Sequence.Tree.Path

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.