gnu.trove.stack.array
Class TShortArrayStack

java.lang.Object
  gnu.trove.stack.array.TShortArrayStack

All Implemented Interfaces:

TShortStack, java.io.Externalizable, java.io.Serializable

public class TShortArrayStack
extends java.lang.Object
implements TShortStack, java.io.Externalizable

A stack of short primitives, backed by a TShortArrayList

See Also:

Serialized Form

Field Summary

protected TShortArrayList	_list the list used to hold the stack values.
static int	DEFAULT_CAPACITY

Constructor Summary

TShortArrayStack()
Creates a new TShortArrayStack instance with the default capacity.

TShortArrayStack(int capacity)
Creates a new TShortArrayStack instance with the specified capacity.

TShortArrayStack(int capacity, short no_entry_value)
Creates a new TShortArrayStack instance with the specified capacity.

TShortArrayStack(TShortStack stack)
Creates a new TShortArrayStack instance that is a copy of the instanced passed to us.

Method Summary

void	clear() Clears the stack.
boolean	equals(java.lang.Object o)
short	getNoEntryValue() Returns the value that is used to represent null.
int	hashCode()
short	peek() Returns the value at the top of the stack.
short	pop() Removes and returns the value at the top of the stack.
void	push(short val) Pushes the value onto the top of the stack.
void	readExternal(java.io.ObjectInput in)
int	size() Returns the current depth of the stack.
short[]	toArray() Copies the contents of the stack into a native array.
void	toArray(short[] dest) Copies a slice of the list into a native array.
java.lang.String	toString() Returns a String representation of the list, top to bottom.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

_list

protected TShortArrayList _list

the list used to hold the stack values.

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

See Also:

Constant Field Values

Constructor Detail

TShortArrayStack

public TShortArrayStack()

Creates a new TShortArrayStack instance with the default capacity.

TShortArrayStack

public TShortArrayStack(int capacity)

Creates a new TShortArrayStack instance with the specified capacity.

Parameters:

capacity - the initial depth of the stack

TShortArrayStack

public TShortArrayStack(int capacity,
                        short no_entry_value)

Creates a new TShortArrayStack instance with the specified capacity.

Parameters:

capacity - the initial depth of the stack

no_entry_value - value that represents null

TShortArrayStack

public TShortArrayStack(TShortStack stack)

Creates a new TShortArrayStack instance that is a copy of the instanced passed to us.

Parameters:

stack - the instance to copy

Method Detail

getNoEntryValue

public short getNoEntryValue()

Returns the value that is used to represent null. The default value is generally zero, but can be changed during construction of the collection.

Specified by:

getNoEntryValue in interface TShortStack

Returns:

the value that represents null

push

public void push(short val)

Pushes the value onto the top of the stack.

Specified by:

push in interface TShortStack

Parameters:

val - an short value

pop

public short pop()

Removes and returns the value at the top of the stack.

Specified by:

pop in interface TShortStack

Returns:

an short value

peek

public short peek()

Returns the value at the top of the stack.

Specified by:

peek in interface TShortStack

Returns:

an short value

size

public int size()

Returns the current depth of the stack.

Specified by:

size in interface TShortStack

clear

public void clear()

Clears the stack.

Specified by:

clear in interface TShortStack

toArray

public short[] toArray()

Copies the contents of the stack into a native array. Note that this will NOT pop them out of the stack. The front of the list will be the top of the stack.

Specified by:

toArray in interface TShortStack

Returns:

an short[] value

toArray

public void toArray(short[] dest)

Copies a slice of the list into a native array. Note that this will NOT pop them out of the stack. The front of the list will be the top of the stack.

If the native array is smaller than the stack depth, the native array will be filled with the elements from the top of the array until it is full and exclude the remainder.

Specified by:

toArray in interface TShortStack

Parameters:

dest - the array to copy into.

toString

public java.lang.String toString()

Returns a String representation of the list, top to bottom.

Overrides:

toString in class java.lang.Object

Returns:

a String value

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException