Package org.jibx.runtime.impl

Class GrowableStringArray

java.lang.Object
org.jibx.runtime.impl.GrowableStringArray
public class GrowableStringArray extends Object
Growable String array 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 Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_SIZE
    Default initial array size.
    private String[]
    m_baseArray
    The underlying array used for storing the data.
    private int
    m_countLimit
    Size of the current array.
    private int
    m_countPresent
    The number of values currently present in the array.
    private int
    m_maximumGrowth
    Maximum size increment for growing array.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GrowableStringArray()
    Default constructor.
    GrowableStringArray(int size)
    Constructor with initial size specified.
    GrowableStringArray(int size, int growth)
    Constructor with full specification.
    GrowableStringArray(GrowableStringArray base)
    Copy (clone) constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(String value)
    Add a value at the end of the array.
    void
    addAll(String[] values)
    Add an array of values at the end of the array.
    void
    clear()
    Set the array to the empty state.
    Object
    clone()
    Duplicates the object with the generic call.
    private void
    discardValues(int from, int to)
    Discards values for a range of indices in the array.
    final void
    ensureCapacity(int min)
    Ensure that the array has the capacity for at least the specified number of values.
    String
    get(int index)
    Get a value from the array.
    private int
    getAddIndex()
    Gets the array offset for appending a value to those in the array.
    private void
    growArray(int required)
    Increase the size of the array to at least a specified size.
    boolean
    isEmpty()
    Check if array is empty.
    void
    remove(int count)
    Remove some number of values from the end of the array.
    private void
    resizeCopy(Object base, Object grown)
    Copy data after array resize.
    void
    set(int index, String value)
    Overwrite an existing value in the array.
    int
    size()
    Get the number of values currently present in the array.
    String[]
    toArray()
    Constructs and returns a simple array containing the same data as held in this array.

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • DEFAULT_SIZE

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

    • m_countLimit

      private int m_countLimit
      Size of the current array.

    • m_countPresent

      private int m_countPresent
      The number of values currently present in the array.

    • m_maximumGrowth

      private int m_maximumGrowth
      Maximum size increment for growing array.

    • m_baseArray

      private String[] m_baseArray
      The underlying array used for storing the data.

  • Constructor Details

    • GrowableStringArray

      public GrowableStringArray(int size, int growth)
      Constructor with full specification.
      Parameters:
      size - number of String values initially allowed in array
      growth - maximum size increment for growing array

    • GrowableStringArray

      public GrowableStringArray(int size)
      Constructor with initial size specified.
      Parameters:
      size - number of String values initially allowed in array

    • GrowableStringArray

      public GrowableStringArray()
      Default constructor.

    • GrowableStringArray

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

  • Method Details

    • resizeCopy

      private void resizeCopy(Object base, Object grown)
      Copy data after array resize. This just copies the entire contents of the old array to the start of the new array. It should be overridden in cases where data needs to be rearranged in the array after a resize.
      Parameters:
      base - original array containing data
      grown - resized array for data

    • discardValues

      private void discardValues(int from, int to)
      Discards values for a range of indices in the array. Clears references to removed values.
      Parameters:
      from - index of first value to be discarded
      to - index past last value to be discarded

    • growArray

      private void growArray(int required)
      Increase the size of the array to at least a specified size. The array will normally be at least doubled in size, but if a maximum size increment was specified in the constructor and the value is less than the current size of the array, the maximum increment will be used instead. If the requested size requires more than the default growth, the requested size overrides the normal growth and determines the size of the replacement array.
      Parameters:
      required - new minimum size required

    • 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

    • set

      public void set(int index, String value)
      Overwrite an existing value in the array.
      Parameters:
      index - position of value to be overwritten
      value - value to be added

    • add

      public void add(String value)
      Add a value at the end of the array.
      Parameters:
      value - value to be added

    • addAll

      public void addAll(String[] values)
      Add an array of values at the end of the array.
      Parameters:
      values - values to be added

    • remove

      public void remove(int count)
      Remove some number of values from the end of the array.
      Parameters:
      count - number of values to be removed
      Throws:
      ArrayIndexOutOfBoundsException - on attempt to remove more than the count present

    • get

      public String get(int index)
      Get a value from the array.
      Parameters:
      index - index of value to be returned
      Returns:
      value from stack
      Throws:
      ArrayIndexOutOfBoundsException - on attempt to access outside valid range

    • toArray

      public String[] toArray()
      Constructs and returns a simple array containing the same data as held in this 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

    • getAddIndex

      private int getAddIndex()
      Gets the array offset for appending a value to those in the array. If the underlying array is full, it is grown by the appropriate size increment so that the index value returned is always valid for the array in use by the time of the return.
      Returns:
      index position for added element

    • size

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

    • isEmpty

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

    • clear

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