com.sosnoski.util.stack
Class IntStack

java.lang.Object
  |
  +--com.sosnoski.util.GrowableBase
        |
        +--com.sosnoski.util.stack.StackBase
              |
              +--com.sosnoski.util.stack.IntStack

public class IntStack

extends StackBase

Growable int stack with type specific access methods. This implementation is unsynchronized in order to provide the best possible performance for typical usage scenarios, so explicit synchronization must be implemented by a wrapper class or directly by the application in cases where instances are modified in a multithreaded environment. See the base classes for other details of the implementation.

Version:

1.0

Author:

Dennis M. Sosnoski

Field Summary

protected int[]

m_baseArray The underlying array used for storing the data.

Fields inherited from class com.sosnoski.util.stack.StackBase

m_countPresent

Fields inherited from class com.sosnoski.util.GrowableBase

DEFAULT_SIZE, m_countLimit, m_maximumGrowth

Constructor Summary

IntStack()
Default constructor.

IntStack(int size)
Constructor with initial size specified.

IntStack(int size, int growth)
Constructor with full specification.

IntStack(IntStack base)
Copy (clone) constructor.

Method Summary

java.lang.Object	clone() Duplicates the object with the generic call.
protected java.lang.Object	getArray() Get the backing array.
int	peek() Copy top value from the stack.
int	peek(int depth) Copy a value from the stack.
int	pop() Pop a value from the stack.
int	pop(int count) Pop multiple values from the stack.
void	push(int value) Push a value on the stack.
protected void	setArray(java.lang.Object array) Set the backing array.
int[]	toArray() Constructs and returns a simple array containing the same data as held in this stack.

Methods inherited from class com.sosnoski.util.stack.StackBase

buildArray, clear, getAddIndex, isEmpty, size

Methods inherited from class com.sosnoski.util.GrowableBase

buildArray, discardValues, ensureCapacity, growArray, resizeCopy

Methods inherited from class java.lang.Object

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

Field Detail

m_baseArray

protected int[] m_baseArray

The underlying array used for storing the data.

Constructor Detail

IntStack

public IntStack(int size,
                int growth)

Constructor with full specification.

Parameters:

size - number of int values initially allowed in stack

growth - maximum size increment for growing stack

IntStack

public IntStack(int size)

Constructor with initial size specified.

Parameters:

size - number of int values initially allowed in stack

IntStack

public IntStack()

Default constructor.

IntStack

public IntStack(IntStack base)

Copy (clone) constructor.

Parameters:

base - instance being copied

Method Detail

getArray

protected java.lang.Object getArray()

Get the backing array. This method is used by the type-agnostic base class code to access the array used for type-specific storage.

Overrides:

getArray in class GrowableBase

Returns:

backing array object

setArray

protected void setArray(java.lang.Object array)

Set the backing array. This method is used by the type-agnostic base class code to set the array used for type-specific storage.

Overrides:

setArray in class GrowableBase

Parameters:

backing - array object

push

public void push(int value)

Push a value on the stack.

Parameters:

value - value to be added

pop

public int pop()

Pop a value from the stack.

Returns:

value from top of stack

Throws:

java.lang.ArrayIndexOutOfBoundsException - on attempt to pop empty stack

pop

public int pop(int count)

Pop multiple values from the stack. The last value popped is the one returned.

Parameters:

count - number of values to pop from stack (must be strictly positive)

Returns:

value from top of stack

Throws:

java.lang.ArrayIndexOutOfBoundsException - on attempt to pop past end of stack

peek

public int peek(int depth)

Copy a value from the stack. This returns a value from within the stack without modifying the stack.

Parameters:

depth - depth of value to be returned

Returns:

value from stack

Throws:

java.lang.ArrayIndexOutOfBoundsException - on attempt to peek past end of stack

peek

public int peek()

Copy top value from the stack. This returns the top value without removing it from the stack.

Returns:

value at top of stack

Throws:

java.lang.ArrayIndexOutOfBoundsException - on attempt to peek empty stack

toArray

public int[] toArray()

Constructs and returns a simple array containing the same data as held in this stack. Note that the items will be in reverse pop order, with the last item to be popped from the stack as the first item in the array.

Returns:

array containing a copy of the data

clone

public java.lang.Object clone()

Duplicates the object with the generic call.

Overrides:

clone in class java.lang.Object

Returns:

a copy of the object