Package gnu.trove.stack.array

Class TByteArrayStack

java.lang.Object
gnu.trove.stack.array.TByteArrayStack
All Implemented Interfaces:
TByteStack, Externalizable, Serializable
public class TByteArrayStack extends Object implements TByteStack, Externalizable
A stack of byte primitives, backed by a TByteArrayList
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected TByteArrayList
    _list
    the list used to hold the stack values.
    static final int
    DEFAULT_CAPACITY
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    TByteArrayStack()
    Creates a new TByteArrayStack instance with the default capacity.
    TByteArrayStack(int capacity)
    Creates a new TByteArrayStack instance with the specified capacity.
    TByteArrayStack(int capacity, byte no_entry_value)
    Creates a new TByteArrayStack instance with the specified capacity.
    TByteArrayStack(TByteStack stack)
    Creates a new TByteArrayStack instance that is a copy of the instanced passed to us.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Clears the stack.
    boolean
    equals(Object o)
     
    byte
    getNoEntryValue()
    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
    readExternal(ObjectInput in)
     
    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.
    String
    toString()
    Returns a String representation of the list, top to bottom.
    void
    writeExternal(ObjectOutput out)
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • TByteArrayStack

      public TByteArrayStack()
      Creates a new TByteArrayStack instance with the default capacity.

    • TByteArrayStack

      public TByteArrayStack(int capacity)
      Creates a new TByteArrayStack instance with the specified capacity.
      Parameters:
      capacity - the initial depth of the stack

    • TByteArrayStack

      public TByteArrayStack(int capacity, byte no_entry_value)
      Creates a new TByteArrayStack instance with the specified capacity.
      Parameters:
      capacity - the initial depth of the stack
      no_entry_value - value that represents null

    • TByteArrayStack

      public TByteArrayStack(TByteStack stack)
      Creates a new TByteArrayStack 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 interface TByteStack
      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 interface TByteStack
      Parameters:
      val - an byte value

    • pop

      public byte pop()
      Removes and returns the value at the top of the stack.
      Specified by:
      pop in interface TByteStack
      Returns:
      an byte value

    • peek

      public byte peek()
      Returns the value at the top of the stack.
      Specified by:
      peek in interface TByteStack
      Returns:
      an byte value

    • size

      public int size()
      Returns the current depth of the stack.
      Specified by:
      size in interface TByteStack

    • clear

      public void clear()
      Clears the stack.
      Specified by:
      clear in interface TByteStack

    • 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 interface TByteStack
      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 interface TByteStack
      Parameters:
      dest - the array to copy into.

    • toString

      public String toString()
      Returns a String representation of the list, top to bottom.
      Overrides:
      toString in class Object
      Returns:
      a String value

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • writeExternal

      public void writeExternal(ObjectOutput out) throws IOException
      Specified by:
      writeExternal in interface Externalizable
      Throws:
      IOException

    • readExternal

      public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
      Specified by:
      readExternal in interface Externalizable
      Throws:
      IOException
      ClassNotFoundException