ifs.fnd.util

Class SimpleStack<E>

java.lang.Object

ifs.fnd.util.SimpleStack<E>

Type Parameters:

E - the type of elements stored on the stack

public class SimpleStack<E>
extends java.lang.Object

Simple unsynchronized implementation of stack.

Constructor Summary

Constructors

Constructor and Description
SimpleStack() Creates an empty stack.

Method Summary

Modifier and Type	Method and Description
boolean	empty() Tests if this stack is empty.
E	get(int index) Returns the item at the specified index.
E	peek() Looks at the object at the top of this stack without removing it from the stack.
E	pop() Removes the object at the top of this stack and returns that object as the value of this function.
E	push(E item) Pushes an item onto the top of this stack.
int	search(java.lang.Object o) Returns the 1-based position where an object is on this stack.
int	size() Returns the number of items on this stack.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleStack

public SimpleStack()

Creates an empty stack.

Method Detail

push

public E push(E item)

Pushes an item onto the top of this stack.

Parameters:

item - the item to be pushed onto this stack.

Returns:

the item argument.

pop

public E 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:

java.util.EmptyStackException - if this stack is empty.

peek

public E 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:

java.util.EmptyStackException - if this stack is empty.

empty

public boolean empty()

Tests if this stack is empty.

Returns:

true if and only if this stack contains no items; false otherwise.

search

public int search(java.lang.Object o)

Returns the 1-based position where an object is on this stack. If the object o occurs as an item in this stack, this method returns the distance from the top of the stack of the occurrence nearest the top of the stack; the topmost item on the stack is considered to be at distance 1. The equals method is used to compare o to the items in this stack.

Parameters:

o - the desired object.

Returns:

the 1-based position from the top of the stack where the object is located; the return value -1 indicates that the object is not on the stack.

size

public int size()

Returns the number of items on this stack.

Returns:

the number of items in the stack

get

public E get(int index)

Returns the item at the specified index. This method is identical in functionality to the get method in the List interface.

Parameters:

index - an index into this stack

Returns:

the item at the specified index

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the index is negative or not less than the current size of this stack

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object