Package gnu.trove.stack.array

Class TShortArrayStack

java.lang.Object
gnu.trove.stack.array.TShortArrayStack
All Implemented Interfaces:
TShortStack, Externalizable, Serializable
public class TShortArrayStack extends Object implements TShortStack, Externalizable
A stack of short primitives, backed by a TShortArrayList
See Also:

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    TShortArrayStack()
    Creates a new TShortArrayStack instance with the default capacity.
    TShortArrayStack(int capacity)
    Creates a new TShortArrayStack instance with the specified capacity.
    TShortArrayStack(int capacity, short no_entry_value)
    Creates a new TShortArrayStack instance with the specified capacity.
    TShortArrayStack(TShortStack stack)
    Creates a new TShortArrayStack 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)
     
    short
    getNoEntryValue()
    Returns the value that is used to represent null.
    int
    hashCode()
     
    short
    peek()
    Returns the value at the top of the stack.
    short
    pop()
    Removes and returns the value at the top of the stack.
    void
    push(short val)
    Pushes the value onto the top of the stack.
    void
    readExternal(ObjectInput in)
     
    int
    size()
    Returns the current depth of the stack.
    short[]
    toArray()
    Copies the contents of the stack into a native array.
    void
    toArray(short[] 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

    • TShortArrayStack

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

    • TShortArrayStack

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

    • TShortArrayStack

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

    • TShortArrayStack

      public TShortArrayStack(TShortStack stack)
      Creates a new TShortArrayStack instance that is a copy of the instanced passed to us.
      Parameters:
      stack - the instance to copy

  • Method Details

    • getNoEntryValue

      public short 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 TShortStack
      Returns:
      the value that represents null

    • push

      public void push(short val)
      Pushes the value onto the top of the stack.
      Specified by:
      push in interface TShortStack
      Parameters:
      val - an short value

    • pop

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

    • peek

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

    • size

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

    • clear

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

    • toArray

      public short[] 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 TShortStack
      Returns:
      an short[] value

    • toArray

      public void toArray(short[] 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 TShortStack
      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