gnu.trove.TByteStack Maven / Gradle / Ivy
///////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2001, Eric D. Friedman All Rights Reserved.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
///////////////////////////////////////////////////////////////////////////////
package gnu.trove;
/**
* A stack of byte primitives, backed by a TByteArrayList.
*
* @author Eric D. Friedman, Rob Eden
* @version $Id: PStack.template,v 1.2 2007/02/28 23:03:57 robeden Exp $
*/
public class TByteStack {
/** the list used to hold the stack values. */
protected TByteArrayList _list;
public static final int DEFAULT_CAPACITY = TByteArrayList.DEFAULT_CAPACITY;
/**
* Creates a new TByteStack instance with the default
* capacity.
*/
public TByteStack() {
this(DEFAULT_CAPACITY);
}
/**
* Creates a new TByteStack instance with the
* specified capacity.
*
* @param capacity the initial depth of the stack
*/
public TByteStack(int capacity) {
_list = new TByteArrayList(capacity);
}
/**
* Pushes the value onto the top of the stack.
*
* @param val an byte value
*/
public void push(byte val) {
_list.add(val);
}
/**
* Removes and returns the value at the top of the stack.
*
* @return an byte value
*/
public byte pop() {
return _list.remove(_list.size() - 1);
}
/**
* Returns the value at the top of the stack.
*
* @return an byte value
*/
public byte peek() {
return _list.get(_list.size() - 1);
}
/**
* Returns the current depth of the stack.
*/
public int size() {
return _list.size();
}
/**
* Clears the stack, reseting its capacity to the default.
*/
public void clear() {
_list.clear(DEFAULT_CAPACITY);
}
/**
* Clears the stack without releasing its internal capacity allocation.
*/
public void reset() {
_list.reset();
}
/**
* Copies the contents of the stack into a native array. Note that this will NOT
* pop them out of the stack.
*
* @return an byte[] value
*/
public byte[] toNativeArray() {
return _list.toNativeArray();
}
/**
* Copies a slice of the list into a native array. Note that this will NOT
* pop them out of the stack.
*
* @param dest the array to copy into.
*/
public void toNativeArray(byte[] dest) {
_list.toNativeArray(dest, 0, size());
}
} // TByteStack