Package gnu.trove.stack.array

Class TCharArrayStack

java.lang.Object
gnu.trove.stack.array.TCharArrayStack
All Implemented Interfaces:
TCharStack, Externalizable, Serializable
public class TCharArrayStack extends Object implements TCharStack, Externalizable
A stack of char primitives, backed by a TCharArrayList
See Also:

  • Field Summary

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

  • Constructor Summary

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

    • TCharArrayStack

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

    • TCharArrayStack

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

    • TCharArrayStack

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

    • TCharArrayStack

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

  • Method Details

    • getNoEntryValue

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

    • push

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

    • pop

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

    • peek

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

    • size

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

    • clear

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

    • toArray

      public char[] 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 TCharStack
      Returns:
      an char[] value

    • toArray

      public void toArray(char[] 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 TCharStack
      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