Package org.web3d.util

Interface SimpleStackInterface

All Known Implementing Classes:

SimpleStack, SimpleStackLogged

public interface SimpleStackInterface

A stack that has a minimal implementation.

Version:

$Revision: 1.10 $

Author:

Alan Hudson

See Also:

• Stack

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears this stack so that it contains no values.
boolean	contains(Object value)	Returns true if this stack contains an instance of the value.
boolean	isEmpty()	Tests if this stack maps no values.
Object	peek()	Peek at the value on the top of the stack without removing it.
Object	pop()	Pop the value from the top of the stack.
void	push(Object val)	Push a new value onto the top of the stack.
void	remove(Object obj)	Remove the given object from the stack if it exists.
int	size()	Returns the number of keys in this hashtable.

Method Details

size

int size()

Returns the number of keys in this hashtable.

Returns:

the number of keys in this hashtable.

isEmpty

boolean isEmpty()

Tests if this stack maps no values.

Returns:

true if this stack has no values

push

void push(Object val)

Push a new value onto the top of the stack. The value may be any legal reference to an object including null.

Parameters:

val - The new value for the stack.

peek

Object peek()
     throws EmptyStackException

Peek at the value on the top of the stack without removing it. If the value pushed was null, then null is returned here.

Returns:

A reference to the object on the top of the stack

Throws:

EmptyStackException - The stack is currently empty

pop

Object pop()

Pop the value from the top of the stack. If the last value in the stack was null then this will return null.

Returns:

The top object on the stack

contains

boolean contains(Object value)

Returns true if this stack contains an instance of the value. The checl looks at both the reference comparison (==) and the equality using .equals(). If the stack is currently empty this will always return false. The search order is from the top of the stack towards the bottom.

Parameters:

value - The value whose presence in this stack is to be tested.

Returns:

true if this stack contains the value.

remove

void remove(Object obj)

Remove the given object from the stack if it exists. If it is not in the stack, then ignore it quietly.

Parameters:

obj - The object to be removed

clear

void clear()

Clears this stack so that it contains no values.