bak.pcj.list
Class BooleanArrayStack

java.lang.Object
  bak.pcj.AbstractBooleanCollection
      bak.pcj.list.AbstractBooleanList
          bak.pcj.list.BooleanArrayList
              bak.pcj.list.BooleanArrayStack

All Implemented Interfaces:

BooleanCollection, BooleanList, BooleanStack, Cloneable, Serializable

public class BooleanArrayStack

extends BooleanArrayList

implements BooleanStack

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

Since:

1.0

See Also:

ArrayList, Serialized Form

Field Summary

Fields inherited from class bak.pcj.list.BooleanArrayList

DEFAULT_CAPACITY, DEFAULT_GROWTH_CHUNK, DEFAULT_GROWTH_FACTOR

Constructor Summary

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

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

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

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

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

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

Method Summary

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

Methods inherited from class bak.pcj.list.BooleanArrayList

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.AbstractBooleanList

add, addAll, iterator, lastIndexOf, listIterator, listIterator

Methods inherited from class bak.pcj.AbstractBooleanCollection

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.BooleanList

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

Methods inherited from interface bak.pcj.BooleanCollection

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

Constructor Detail

BooleanArrayStack

public BooleanArrayStack()

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

See Also:

BooleanArrayStack(int,double)

BooleanArrayStack

public BooleanArrayStack(BooleanCollection 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.

BooleanArrayStack

public BooleanArrayStack(boolean[] 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

BooleanArrayStack

public BooleanArrayStack(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:

BooleanArrayStack(int,double)

BooleanArrayStack

public BooleanArrayStack(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.

BooleanArrayStack

public BooleanArrayStack(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(boolean v)

Description copied from interface: BooleanStack

Pushes a specified element onto this stack.

Specified by:

push in interface BooleanStack

Parameters:

v - the element to push onto this stack.

pop

public boolean pop()

Description copied from interface: BooleanStack

Pops an element off this stack.

Specified by:

pop in interface BooleanStack

Returns:

the element that was popped off this stack.

See Also:

BooleanStack.peek()

peek

public boolean peek()

Description copied from interface: BooleanStack

Returns the top element of this stack.

Specified by:

peek in interface BooleanStack

Returns:

the top element of this stack.

See Also:

BooleanStack.pop()