org.apache.xml.serializer.utils
Class BoolStack

java.lang.Object
  org.apache.xml.serializer.utils.BoolStack

public final class BoolStack
extends java.lang.Object

Simple stack for boolean values. This class is a copy of the one in org.apache.xml.utils. It exists to cut the serializers dependancy on that package. A minor changes from that package are: doesn't implement Clonable This class is not a public API, it is only public because it is used in org.apache.xml.serializer.

Field Summary

private int	m_allocatedSize Array size allocated
private int	m_index Index into the array of booleans
private boolean[]	m_values Array of boolean values

Constructor Summary

BoolStack()
Default constructor.

BoolStack(int size)
Construct a IntVector, using the given block size.

Method Summary

void	clear() Clears the stack.
private void	grow() Grows the size of the stack
boolean	isEmpty() Tests if this stack is empty.
boolean	peek() Looks at the object at the top of this stack without removing it from the stack.
boolean	peekOrFalse() Looks at the object at the top of this stack without removing it from the stack.
boolean	peekOrTrue() Looks at the object at the top of this stack without removing it from the stack.
boolean	pop() Removes the object at the top of this stack and returns that object as the value of this function.
boolean	popAndTop() Removes the object at the top of this stack and returns the next object at the top as the value of this function.
boolean	push(boolean val) Pushes an item onto the top of this stack.
void	setTop(boolean b) Set the item at the top of this stack
int	size() Get the length of the list.

Methods inherited from class java.lang.Object

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

Field Detail

m_values

private boolean[] m_values

Array of boolean values

m_allocatedSize

private int m_allocatedSize

Array size allocated

m_index

private int m_index

Index into the array of booleans

Constructor Detail

BoolStack

public BoolStack()

Default constructor. Note that the default block size is very small, for small lists.

BoolStack

public BoolStack(int size)

Construct a IntVector, using the given block size.

Parameters:

size - array size to allocate

Method Detail

size

public final int size()

Get the length of the list.

Returns:

Current length of the list

clear

public final void clear()

Clears the stack.

push

public final boolean push(boolean val)

Pushes an item onto the top of this stack.

Parameters:

val - the boolean to be pushed onto this stack.

Returns:

the item argument.

pop

public final boolean pop()

Removes the object at the top of this stack and returns that object as the value of this function.

Returns:

The object at the top of this stack.

Throws:

EmptyStackException - if this stack is empty.

popAndTop

public final boolean popAndTop()

Removes the object at the top of this stack and returns the next object at the top as the value of this function.

Returns:

Next object to the top or false if none there

setTop

public final void setTop(boolean b)

Set the item at the top of this stack

Parameters:

b - Object to set at the top of this stack

peek

public final boolean peek()

Looks at the object at the top of this stack without removing it from the stack.

Returns:

the object at the top of this stack.

Throws:

EmptyStackException - if this stack is empty.

peekOrFalse

public final boolean peekOrFalse()

Looks at the object at the top of this stack without removing it from the stack. If the stack is empty, it returns false.

Returns:

the object at the top of this stack.

peekOrTrue

public final boolean peekOrTrue()

Looks at the object at the top of this stack without removing it from the stack. If the stack is empty, it returns true.

Returns:

the object at the top of this stack.

isEmpty

public boolean isEmpty()

Tests if this stack is empty.

Returns:

true if this stack is empty; false otherwise.

grow

private void grow()

Grows the size of the stack