Package gnu.trove.stack.array
Class TByteArrayStack
java.lang.Object
gnu.trove.stack.array.TByteArrayStack
- All Implemented Interfaces:
TByteStack
,Externalizable
,Serializable
A stack of byte primitives, backed by a TByteArrayList
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected TByteArrayList
the list used to hold the stack values.static final int
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a newTByteArrayStack
instance with the default capacity.TByteArrayStack
(int capacity) Creates a newTByteArrayStack
instance with the specified capacity.TByteArrayStack
(int capacity, byte no_entry_value) Creates a newTByteArrayStack
instance with the specified capacity.TByteArrayStack
(TByteStack stack) Creates a newTByteArrayStack
instance that is a copy of the instanced passed to us. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Clears the stack.boolean
byte
Returns the value that is used to represent null.int
hashCode()
byte
peek()
Returns the value at the top of the stack.byte
pop()
Removes and returns the value at the top of the stack.void
push
(byte val) Pushes the value onto the top of the stack.void
int
size()
Returns the current depth of the stack.byte[]
toArray()
Copies the contents of the stack into a native array.void
toArray
(byte[] dest) Copies a slice of the list into a native array.toString()
Returns a String representation of the list, top to bottom.void
-
Field Details
-
_list
the list used to hold the stack values. -
DEFAULT_CAPACITY
public static final int DEFAULT_CAPACITY- See Also:
-
-
Constructor Details
-
TByteArrayStack
public TByteArrayStack()Creates a newTByteArrayStack
instance with the default capacity. -
TByteArrayStack
public TByteArrayStack(int capacity) Creates a newTByteArrayStack
instance with the specified capacity.- Parameters:
capacity
- the initial depth of the stack
-
TByteArrayStack
public TByteArrayStack(int capacity, byte no_entry_value) Creates a newTByteArrayStack
instance with the specified capacity.- Parameters:
capacity
- the initial depth of the stackno_entry_value
- value that represents null
-
TByteArrayStack
Creates a newTByteArrayStack
instance that is a copy of the instanced passed to us.- Parameters:
stack
- the instance to copy
-
-
Method Details
-
getNoEntryValue
public byte getNoEntryValue()Returns the value that is used to represent null. The default value is generally zero, but can be changed during construction of the collection.- Specified by:
getNoEntryValue
in interfaceTByteStack
- Returns:
- the value that represents null
-
push
public void push(byte val) Pushes the value onto the top of the stack.- Specified by:
push
in interfaceTByteStack
- Parameters:
val
- anbyte
value
-
pop
public byte pop()Removes and returns the value at the top of the stack.- Specified by:
pop
in interfaceTByteStack
- Returns:
- an
byte
value
-
peek
public byte peek()Returns the value at the top of the stack.- Specified by:
peek
in interfaceTByteStack
- Returns:
- an
byte
value
-
size
public int size()Returns the current depth of the stack.- Specified by:
size
in interfaceTByteStack
-
clear
public void clear()Clears the stack.- Specified by:
clear
in interfaceTByteStack
-
toArray
public byte[] toArray()Copies the contents of the stack into a native array. Note that this will NOT pop them out of the stack. The front of the list will be the top of the stack.- Specified by:
toArray
in interfaceTByteStack
- Returns:
- an
byte[]
value
-
toArray
public void toArray(byte[] dest) Copies a slice of the list into a native array. Note that this will NOT pop them out of the stack. The front of the list will be the top of the stack.If the native array is smaller than the stack depth, the native array will be filled with the elements from the top of the array until it is full and exclude the remainder.
- Specified by:
toArray
in interfaceTByteStack
- Parameters:
dest
- the array to copy into.
-
toString
Returns a String representation of the list, top to bottom. -
equals
-
hashCode
public int hashCode() -
writeExternal
- Specified by:
writeExternal
in interfaceExternalizable
- Throws:
IOException
-
readExternal
- Specified by:
readExternal
in interfaceExternalizable
- Throws:
IOException
ClassNotFoundException
-