org.apache.commons.collections.primitives
Class IntStack

java.lang.Object
  org.apache.commons.collections.primitives.IntStack

public class IntStack
extends Object

A primitive int based Stack.

Since:

Commons Primitives 1.1

Version:

$Revision: 480460 $ $Date: 2006-11-29 09:14:21 +0100 (Wed, 29 Nov 2006) $

Author:

Apache Directory Project

Constructor Summary

IntStack()

IntStack(int[] numbas)

Method Summary

void	clear() Empties the contents of the stack.
boolean	empty() Tests if this stack is empty.
int	get(int index) Gets items from the stack where the index is zero based and the top of the stack is at an index of size()-1 with the bottom of the stack at an index of 0.
int	peek() Looks at the int at the top of this stack without removing it from the stack.
int	peek(int n) Return the n'th int down the stack, where 0 is the top element and [size()-1] is the bottom element.
int	pop() Removes the int at the top of this stack and returns that object as the value of this function.
int	push(int item) Pushes an int item onto the top of this stack.
int	search(int item) Returns the 1-based position where an int is on this stack.
int	size() Gets the size of this stack.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntStack

public IntStack()

IntStack

public IntStack(int[] numbas)

Method Detail

empty

public boolean empty()

Tests if this stack is empty.

Returns:

true if and only if this stack contains no ints; false otherwise

peek

public int peek()

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

Returns:

int at the top of this stack (last int in ArrayIntList)

Throws:

EmptyStackException - if this stack is empty

peek

public int peek(int n)

Return the n'th int down the stack, where 0 is the top element and [size()-1] is the bottom element.

Parameters:

n - the element index

Returns:

the element at the index

Throws:

EmptyStackException - if the stack is empty

IndexOutOfBoundsException - if the index is out of bounds

pop

public int pop()

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

Returns:

int at the top of this stack (last int in ArrayIntList)

Throws:

EmptyStackException - if this stack is empty

push

public int push(int item)

Pushes an int item onto the top of this stack.

Parameters:

item - the int item to push onto this stack

Returns:

the item argument for call chaining

search

public int search(int item)

Returns the 1-based position where an int is on this stack. If the int 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.

Parameters:

item - the int to search for from the top down

Returns:

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

get

public int get(int index)

Gets items from the stack where the index is zero based and the top of the stack is at an index of size()-1 with the bottom of the stack at an index of 0.

Parameters:

index - the index into the stack treated as a list

Returns:

the int value at the index

size

public int size()

Gets the size of this stack.

Returns:

the size of this stack

clear

public void clear()

Empties the contents of the stack.