org.openorb.util
Class MergeStack

java.lang.Object
  |
  +--java.util.AbstractCollection
        |
        +--java.util.AbstractList
              |
              +--java.util.AbstractSequentialList
                    |
                    +--org.openorb.util.MergeStack

All Implemented Interfaces:

Collection, List

public class MergeStack

extends AbstractSequentialList

A weak set. This does not prevent it's members being reclaimed by the garbage collector.

Version:

$Revision: 1.4 $ $Date: 2004/02/11 12:20:50 $

Author:

Chris Wood

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

MergeStack()
Constructs a new, empty list.

MergeStack(int allocInc)
Constructs a new, empty list with the given allocation increment.

Method Summary

boolean	add(Object obj) Appends the specified element to the end of this stack (optional operation).
void	addFirst(Object obj) Add a new element to the front of the stack.
void	addLast(Object obj) Add a new element to the end of the stack.
void	append(MergeStack next) Append another MergeStack onto this one.
void	clear() Removes all of the elements from this collection.
Object	getFirst() Get the first element in the list.
Object	getLast() Get the first element in the list.
ListIterator	listIterator(int index) Returns a list iterator over the elements in this list (in proper sequence).
Object	removeFirst() Remove and return the first element in the list.
Object	removeLast() Remove and return the last element in the list.
int	size() Returns the number of elements in this collection.

Methods inherited from class java.util.AbstractSequentialList

add, addAll, get, iterator, remove, set

Methods inherited from class java.util.AbstractList

equals, hashCode, indexOf, lastIndexOf, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Constructor Detail

MergeStack

public MergeStack()

Constructs a new, empty list.

MergeStack

public MergeStack(int allocInc)

Constructs a new, empty list with the given allocation increment.

Parameters:

allocInc - The increment value for new allocations.

Method Detail

clear

public void clear()

Removes all of the elements from this collection. The collection will be empty after this call returns.

Overrides:

clear in class AbstractList

listIterator

public ListIterator listIterator(int index)

Returns a list iterator over the elements in this list (in proper sequence).

Overrides:

listIterator in class AbstractSequentialList

Parameters:

index - ???

Returns:

A list iterator over the elements in this list (in proper sequence).

size

public int size()

Returns the number of elements in this collection. If the collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Overrides:

size in class AbstractCollection

Returns:

the number of elements in this collection.

add

public boolean add(Object obj)

Appends the specified element to the end of this stack (optional operation).

Overrides:

add in class AbstractList

Parameters:

obj - The element to be appended to this stack.

Returns:

true (as per the general contract of Collection.add).

getFirst

public Object getFirst()
                throws NoSuchElementException

Get the first element in the list.

Returns:

the first element from the list

Throws:

NoSuchElementException - if the list is empty.

addFirst

public void addFirst(Object obj)

Add a new element to the front of the stack.

Parameters:

obj - The object to add to the stack.

removeFirst

public Object removeFirst()
                   throws NoSuchElementException

Remove and return the first element in the list.

Returns:

The first element from the list.

Throws:

NoSuchElementException - if the list is empty.

getLast

public Object getLast()
               throws NoSuchElementException

Get the first element in the list.

Returns:

The first element from the list.

Throws:

NoSuchElementException - if the list is empty.

addLast

public void addLast(Object obj)

Add a new element to the end of the stack.

Parameters:

obj - The new element to add to the stack.

removeLast

public Object removeLast()
                  throws NoSuchElementException

Remove and return the last element in the list.

Returns:

the last element from the list

Throws:

NoSuchElementException - if the list is empty.

append

public void append(MergeStack next)

Append another MergeStack onto this one. The other merge stack will end up empty.

Parameters:

next - Another MergeStack instance to append.