PCJ API
Version 1.2

bak.pcj.list
Class CharArrayStack

java.lang.Object
  extended bybak.pcj.AbstractCharCollection
      extended bybak.pcj.list.AbstractCharList
          extended bybak.pcj.list.CharArrayList
              extended bybak.pcj.list.CharArrayStack
All Implemented Interfaces:
CharCollection, CharList, CharStack, Cloneable, Serializable

public class CharArrayStack
extends CharArrayList
implements CharStack

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

Since:
1.0
See Also:
ArrayList, Serialized Form

Field Summary
 
Fields inherited from class bak.pcj.list.CharArrayList
DEFAULT_CAPACITY, DEFAULT_GROWTH_CHUNK, DEFAULT_GROWTH_FACTOR
 
Constructor Summary
CharArrayStack()
          Creates a new array stack with capacity 10 and a relative growth factor of 1.0.
CharArrayStack(char[] a)
          Creates a new array stack with the same elements as a specified array.
CharArrayStack(CharCollection c)
          Creates a new array stack with the same elements as a specified collection.
CharArrayStack(int capacity)
          Creates a new array stack with a specified capacity and a relative growth factor of 1.0.
CharArrayStack(int capacity, double growthFactor)
          Creates a new array stack with a specified capacity and relative growth factor.
CharArrayStack(int capacity, int growthChunk)
          Creates a new array stack with a specified capacity and absolute growth factor.
 
Method Summary
 char peek()
          Returns the top element of this stack.
 char pop()
          Pops an element off this stack.
 void push(char v)
          Pushes a specified element onto this stack.
 
Methods inherited from class bak.pcj.list.CharArrayList
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.AbstractCharList
add, addAll, iterator, lastIndexOf, listIterator, listIterator
 
Methods inherited from class bak.pcj.AbstractCharCollection
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.CharList
add, addAll, get, indexOf, indexOf, lastIndexOf, lastIndexOf, listIterator, listIterator, removeElementAt, set
 
Methods inherited from interface bak.pcj.CharCollection
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, trimToSize
 

Constructor Detail

CharArrayStack

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

See Also:
CharArrayStack(int,double)

CharArrayStack

public CharArrayStack(CharCollection 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.

CharArrayStack

public CharArrayStack(char[] 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

CharArrayStack

public CharArrayStack(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:
CharArrayStack(int,double)

CharArrayStack

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

CharArrayStack

public CharArrayStack(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(char v)
Description copied from interface: CharStack
Pushes a specified element onto this stack.

Specified by:
push in interface CharStack
Parameters:
v - the element to push onto this stack.

pop

public char pop()
Description copied from interface: CharStack
Pops an element off this stack.

Specified by:
pop in interface CharStack
Returns:
the element that was popped off this stack.
See Also:
CharStack.peek()

peek

public char peek()
Description copied from interface: CharStack
Returns the top element of this stack.

Specified by:
peek in interface CharStack
Returns:
the top element of this stack.
See Also:
CharStack.pop()

PCJ API
Version 1.2

Report a bug or request a feature.
Further information on the development and latest release of PCJ can be found at the project homepage.

Primitive Collections for Java is released under the GNU Lesser General Public License.
Copyright © 2002, 2003 Søren Bak. All Rights Reserved.

Hosted by SourceForge.net
SourceForge.net Logo