Package org.jibx.binding.util

Class ObjectStack

  • public class ObjectStack
extends Object
    Growable Object stack with type specific access methods. This implementation is unsynchronized in order to provide the best possible performance for typical usage scenarios, so explicit synchronization must be implemented by a wrapper class or directly by the application in cases where instances are modified in a multithreaded environment.
    Author:
    Dennis M. Sosnoski

    • Field Detail

      • DEFAULT_SIZE

        public static final int DEFAULT_SIZE
        Default initial array size.
        See Also:
        Constant Field Values

      • m_countLimit

        protected int m_countLimit
        Size of the current array.

      • m_countPresent

        protected int m_countPresent
        The number of values currently present in the stack.

      • m_maximumGrowth

        protected int m_maximumGrowth
        Maximum size increment for growing array.

      • m_baseArray

        protected Object[] m_baseArray
        The underlying array used for storing the data.

    • Constructor Detail

      • ObjectStack

        public ObjectStack​(int size,
                   int growth)
        Constructor with full specification.
        Parameters:
        size - number of Object values initially allowed in stack
        growth - maximum size increment for growing stack

      • ObjectStack

        public ObjectStack​(int size)
        Constructor with initial size specified.
        Parameters:
        size - number of Object values initially allowed in stack

      • ObjectStack

        public ObjectStack()
        Default constructor.

      • ObjectStack

        public ObjectStack​(ObjectStack base)
        Copy (clone) constructor.
        Parameters:
        base - instance being copied

      • ObjectStack

        public ObjectStack​(Object[] strings)
        Constructor from array of strings.
        Parameters:
        strings - array of strings for initial contents

    • Method Detail

      • ensureCapacity

        public final void ensureCapacity​(int min)
        Ensure that the array has the capacity for at least the specified number of values.
        Parameters:
        min - minimum capacity to be guaranteed

      • push

        public void push​(Object value)
        Push a value on the stack.
        Parameters:
        value - value to be added

      • pop

        public Object pop​(int count)
        Pop multiple values from the stack. The last value popped is the one returned.
        Parameters:
        count - number of values to pop from stack (must be strictly positive)
        Returns:
        value from top of stack
        Throws:
        ArrayIndexOutOfBoundsException - on attempt to pop past end of stack

      • peek

        public Object peek​(int depth)
        Copy a value from the stack. This returns a value from within the stack without modifying the stack.
        Parameters:
        depth - depth of value to be returned
        Returns:
        value from stack
        Throws:
        ArrayIndexOutOfBoundsException - on attempt to peek past end of stack

      • peek

        public Object peek()
        Copy top value from the stack. This returns the top value without removing it from the stack.
        Returns:
        value at top of stack
        Throws:
        ArrayIndexOutOfBoundsException - on attempt to peek empty stack

      • toArray

        public Object[] toArray()
        Constructs and returns a simple array containing the same data as held in this stack. Note that the items will be in reverse pop order, with the last item to be popped from the stack as the first item in the array.
        Returns:
        array containing a copy of the data

      • clone

        public Object clone()
        Duplicates the object with the generic call.
        Overrides:
        clone in class Object
        Returns:
        a copy of the object

      • size

        public int size()
        Get the number of values currently present in the stack.
        Returns:
        count of values present

      • isEmpty

        public boolean isEmpty()
        Check if stack is empty.
        Returns:
        true if stack empty, false if not

      • clear

        public void clear()
        Set the stack to the empty state.