bak.pcj.list
Class ByteArrayStack

java.lang.Object
  bak.pcj.AbstractByteCollection
      bak.pcj.list.AbstractByteList
          bak.pcj.list.ByteArrayList
              bak.pcj.list.ByteArrayStack

All Implemented Interfaces:

ByteCollection, ByteList, ByteStack, Cloneable, Serializable

public class ByteArrayStack

extends ByteArrayList

implements ByteStack

This class represents an array implemenation of stacks of byte values.

Since:

1.0

See Also:

ArrayList, Serialized Form

Field Summary

Fields inherited from class bak.pcj.list.ByteArrayList

DEFAULT_CAPACITY, DEFAULT_GROWTH_CHUNK, DEFAULT_GROWTH_FACTOR

Constructor Summary

ByteArrayStack()
Creates a new array stack with capacity 10 and a relative growth factor of 1.0.

ByteArrayStack(byte[] a)
Creates a new array stack with the same elements as a specified array.

ByteArrayStack(ByteCollection c)
Creates a new array stack with the same elements as a specified collection.

ByteArrayStack(int capacity)
Creates a new array stack with a specified capacity and a relative growth factor of 1.0.

ByteArrayStack(int capacity, double growthFactor)
Creates a new array stack with a specified capacity and relative growth factor.

ByteArrayStack(int capacity, int growthChunk)
Creates a new array stack with a specified capacity and absolute growth factor.

Method Summary

byte	peek() Returns the top element of this stack.
byte	pop() Pops an element off this stack.
void	push(byte v) Pushes a specified element onto this stack.

Methods inherited from class bak.pcj.list.ByteArrayList

add, capacity, clear, clone, contains, ensureCapacity, equals, get, hashCode, indexOf, indexOf, isEmpty, lastIndexOf, remove, removeElementAt, set, size, toArray, toArray, trimToSize

Methods inherited from class bak.pcj.list.AbstractByteList

add, addAll, iterator, lastIndexOf, listIterator, listIterator

Methods inherited from class bak.pcj.AbstractByteCollection

addAll, containsAll, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface bak.pcj.list.ByteList

add, addAll, get, indexOf, indexOf, lastIndexOf, lastIndexOf, listIterator, listIterator, removeElementAt, set

Methods inherited from interface bak.pcj.ByteCollection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, trimToSize

Constructor Detail

ByteArrayStack

public ByteArrayStack()

Creates a new array stack with capacity 10 and a relative growth factor of 1.0.

See Also:

ByteArrayStack(int,double)

ByteArrayStack

public ByteArrayStack(ByteCollection c)

Creates a new array stack with the same elements as a specified collection. The elements of the specified collection are pushed in the collection's iteration order.

Parameters:

c - the collection whose elements to add to the new stack.

Throws:

NullPointerException - if c is null.

ByteArrayStack

public ByteArrayStack(byte[] a)

Creates a new array stack with the same elements as a specified array. The elements of the specified array are pushed in the order of the array.

Parameters:

a - the array whose elements to add to the new stack.

Throws:

NullPointerException - if a is null.

Since:

1.1

ByteArrayStack

public ByteArrayStack(int capacity)

Creates a new array stack with a specified capacity and a relative growth factor of 1.0.

Parameters:

capacity - the initial capacity of the stack.

Throws:

IllegalArgumentException - if capacity is negative.

See Also:

ByteArrayStack(int,double)

ByteArrayStack

public ByteArrayStack(int capacity,
                      double growthFactor)

Creates a new array stack with a specified capacity and relative growth factor.

The array capacity increases to capacity()*(1+growthFactor). This strategy is good for avoiding many capacity increases, but the amount of wasted memory is approximately the size of the stack.

Parameters:

capacity - the initial capacity of the stack.

growthFactor - the relative amount with which to increase the the capacity when a capacity increase is needed.

Throws:

IllegalArgumentException - if capacity is negative; if growthFactor is negative.

ByteArrayStack

public ByteArrayStack(int capacity,
                      int growthChunk)

Creates a new array stack with a specified capacity and absolute growth factor.

The array capacity increases to capacity()+growthChunk. This strategy is good for avoiding wasting memory. However, an overhead is potentially introduced by frequent capacity increases.

Parameters:

capacity - the initial capacity of the stack.

growthChunk - the absolute amount with which to increase the the capacity when a capacity increase is needed.

Throws:

IllegalArgumentException - if capacity is negative; if growthChunk is negative.

Method Detail

push

public void push(byte v)

Description copied from interface: ByteStack

Pushes a specified element onto this stack.

Specified by:

push in interface ByteStack

Parameters:

v - the element to push onto this stack.

pop

public byte pop()

Description copied from interface: ByteStack

Pops an element off this stack.

Specified by:

pop in interface ByteStack

Returns:

the element that was popped off this stack.

See Also:

ByteStack.peek()

peek

public byte peek()

Description copied from interface: ByteStack

Returns the top element of this stack.

Specified by:

peek in interface ByteStack

Returns:

the top element of this stack.

See Also:

ByteStack.pop()