org.apache.pivot.wtk
Class Alert.OptionSequence

java.lang.Object
  extended by org.apache.pivot.wtk.Alert.OptionSequence
All Implemented Interfaces:
Iterable<Object>, Sequence<Object>
Enclosing class:
Alert

public final class Alert.OptionSequence
extends Object
implements Sequence<Object>, Iterable<Object>

Option sequence implementation.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence
Sequence.Tree<T>
 
Method Summary
 int add(Object option)
          Adds an item to the sequence.
 Object get(int index)
          Retrieves the item at the given index.
 int getLength()
          Returns the length of the sequence.
 int indexOf(Object option)
          Returns the index of an item in the sequence.
 void insert(Object option, int index)
          Inserts an item into the sequence at a specific index.
 Iterator<Object> iterator()
           
 Sequence<Object> remove(int index, int count)
          Removes one or more items from the sequence.
 int remove(Object option)
          Removes the first occurrence of the given item from the sequence.
 Component update(int index, Object option)
          Updates the item at the given index.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

add

public int add(Object option)
Description copied from interface: Sequence
Adds an item to the sequence.

Specified by:
add in interface Sequence<Object>
Parameters:
option - 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(Object option,
                   int index)
Description copied from interface: Sequence
Inserts an item into the sequence at a specific index.

Specified by:
insert in interface Sequence<Object>
Parameters:
option - 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 Component update(int index,
                        Object option)
Description copied from interface: Sequence
Updates the item at the given index.

Specified by:
update in interface Sequence<Object>
Parameters:
index - The index of the item to update.
option - 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(Object option)
Description copied from interface: Sequence
Removes the first occurrence of the given item from the sequence.

Specified by:
remove in interface Sequence<Object>
Parameters:
option - 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<Object> remove(int index,
                               int count)
Description copied from interface: Sequence
Removes one or more items from the sequence.

Specified by:
remove in interface Sequence<Object>
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 Object get(int index)
Description copied from interface: Sequence
Retrieves the item at the given index.

Specified by:
get in interface Sequence<Object>
Parameters:
index - The index of the item to retrieve.

indexOf

public int indexOf(Object option)
Description copied from interface: Sequence
Returns the index of an item in the sequence.

Specified by:
indexOf in interface Sequence<Object>
Parameters:
option - 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<Object>
Returns:
The number of items in the sequence.

iterator

public Iterator<Object> iterator()
Specified by:
iterator in interface Iterable<Object>