com.phloc.commons.collections

Class NonBlockingStack<ELEMENTTYPE>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<ELEMENTTYPE>

com.phloc.commons.collections.NonBlockingStack<ELEMENTTYPE>

Type Parameters:

ELEMENTTYPE - The type of the elements contained in the stack

All Implemented Interfaces:

ICloneable<NonBlockingStack<ELEMENTTYPE>>, IHasSize, Serializable, Cloneable, Iterable<ELEMENTTYPE>, Collection<ELEMENTTYPE>, List<ELEMENTTYPE>, RandomAccess

@NotThreadSafe
public class NonBlockingStack<ELEMENTTYPE>
extends ArrayList<ELEMENTTYPE>
implements IHasSize, ICloneable<NonBlockingStack<ELEMENTTYPE>>

A version of a stack that does not use Vector but an ArrayList as the underlying data structure as opposed to Stack. This spares us from unnecessary synchronization.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
NonBlockingStack()
NonBlockingStack(Collection<? extends ELEMENTTYPE> aCollection)
NonBlockingStack(ELEMENTTYPE... aElements)
NonBlockingStack(NonBlockingStack<? extends ELEMENTTYPE> aStack)

Method Summary

Methods

Modifier and Type	Method and Description
static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE>	create()
static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE>	create(Collection<? extends ELEMENTTYPE> aCont)
static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE>	create(ELEMENTTYPE... aElements)
static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE>	create(NonBlockingStack<? extends ELEMENTTYPE> aStack)
boolean	equals(Object o)
ELEMENTTYPE	firstElement()
NonBlockingStack<ELEMENTTYPE>	getClone()
int	hashCode()
ELEMENTTYPE	peek() Looks at the object at the top of this stack without removing it from the stack.
ELEMENTTYPE	pop() Removes the object at the top of this stack and returns that object as the value of this function.
ELEMENTTYPE	push(ELEMENTTYPE aItem) Pushes an item onto the top of this stack.
ELEMENTTYPE	replaceTopElement(ELEMENTTYPE aItem) Replaces the top element in the stack.
ELEMENTTYPE	top() Looks at the object at the top of this stack without removing it from the stack.
String	toString()

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeRange, retainAll, set, size, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.phloc.commons.IHasSize

isEmpty, size

Methods inherited from interface java.util.List

containsAll

Constructor Detail

NonBlockingStack

public NonBlockingStack()

NonBlockingStack

public NonBlockingStack(@Nullable
                ELEMENTTYPE... aElements)

NonBlockingStack

public NonBlockingStack(@Nullable
                Collection<? extends ELEMENTTYPE> aCollection)

NonBlockingStack

public NonBlockingStack(@Nullable
                NonBlockingStack<? extends ELEMENTTYPE> aStack)

Method Detail

push

@Nullable
public ELEMENTTYPE push(@Nullable
                        ELEMENTTYPE aItem)

Pushes an item onto the top of this stack.

Parameters:

aItem - the item to be pushed onto this stack.

Returns:

the aItem argument.

pop

@Nullable
public ELEMENTTYPE pop()

Removes the object at the top of this stack and returns that object as the value of this function.

Returns:

The object at the top of this stack (the last item of the list).

Throws:

EmptyStackException - if this stack is empty.

peek

@Nullable
public ELEMENTTYPE peek()

Looks at the object at the top of this stack without removing it from the stack.

Returns:

the object at the top of this stack (the last item of the list).

Throws:

EmptyStackException - if this stack is empty.

top

@Nullable
public ELEMENTTYPE top()

Looks at the object at the top of this stack without removing it from the stack. Synonym for peek()

Returns:

the object at the top of this stack (the last item of the list).

Throws:

EmptyStackException - if this stack is empty.

See Also:

peek()

firstElement

@Nullable
public ELEMENTTYPE firstElement()

Returns:

The first element in the stack (the oldest element) in comparison to peek() delivering the last element.

Throws:

EmptyStackException - if the stack is empty

replaceTopElement

@Nullable
public ELEMENTTYPE replaceTopElement(@Nullable
                                     ELEMENTTYPE aItem)

Replaces the top element in the stack. This is a shortcut for pop (); push (aItem);

Parameters:

aItem - the item to be pushed onto this stack.

Returns:

the aItem argument.

Throws:

EmptyStackException - if the stack is empty

getClone

@Nonnull
public NonBlockingStack<ELEMENTTYPE> getClone()

Specified by:

getClone in interface ICloneable<NonBlockingStack<ELEMENTTYPE>>

Returns:

A 100% deep-copy of the implementing class.

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<ELEMENTTYPE>

Specified by:

equals in interface List<ELEMENTTYPE>

Overrides:

equals in class AbstractList<ELEMENTTYPE>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<ELEMENTTYPE>

Specified by:

hashCode in interface List<ELEMENTTYPE>

Overrides:

hashCode in class AbstractList<ELEMENTTYPE>

toString

public String toString()

Overrides:

toString in class AbstractCollection<ELEMENTTYPE>

create

@Nonnull
public static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE> create()

create

@Nonnull
public static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE> create(@Nullable
                                                         ELEMENTTYPE... aElements)

create

@Nonnull
public static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE> create(@Nullable
                                                         Collection<? extends ELEMENTTYPE> aCont)

create

@Nonnull
public static <ELEMENTTYPE> NonBlockingStack<ELEMENTTYPE> create(@Nullable
                                                         NonBlockingStack<? extends ELEMENTTYPE> aStack)