StringLargeArray (JLargeArrays 1.5 API)

java.lang.Object
- pl.edu.icm.jlargearrays.LargeArray
- - pl.edu.icm.jlargearrays.StringLargeArray

All Implemented Interfaces:

Serializable, Cloneable
```
public class StringLargeArray
extends LargeArray
```
An array of strings that can store up to 2⁶³ elements.

Author:

Piotr Wendykier (p.wendykier@icm.edu.pl)

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class pl.edu.icm.jlargearrays.LargeArray
  LargeArray.Deallocator

Field Summary
- Fields inherited from class pl.edu.icm.jlargearrays.LargeArray
  isConstant, LARGEST_SUBARRAY, length, parent, ptr, sizeof, type

Constructor Summary

Constructors
Constructor and Description
`StringLargeArray(long length)` Creates new instance of this class.
`StringLargeArray(long length, int maxStringLength)` Creates new instance of this class.
`StringLargeArray(long length, int maxStringLength, boolean zeroNativeMemory)` Creates new instance of this class.
`StringLargeArray(long length, String constantValue)` Creates a constant array.
`StringLargeArray(String[] data)` Creates new instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringLargeArray`	`clone()` Returns a deep copy of this instance.
`boolean`	`equals(Object o)`
`String`	`get(long i)` Returns a value at index i.
`boolean`	`getBoolean(long i)` Returns a boolean value at index i.
`boolean[]`	`getBooleanData()` If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns boolean data.
`boolean[]`	`getBooleanData(boolean[] a, long startPos, long endPos, long step)` If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object.
`byte`	`getByte(long i)` Returns a signed byte value at index i.
`byte[]`	`getByteData()` If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns byte data.
`byte[]`	`getByteData(byte[] a, long startPos, long endPos, long step)` If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object.
`String[]`	`getData()` Returns a reference to the internal data array.
`double`	`getDouble(long i)` Returns a double value at index i.
`double[]`	`getDoubleData()` If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns double data.
`double[]`	`getDoubleData(double[] a, long startPos, long endPos, long step)` If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object.
`float`	`getFloat(long i)` Returns a float value at index i.
`float[]`	`getFloatData()` If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns float data.
`float[]`	`getFloatData(float[] a, long startPos, long endPos, long step)` If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object.
`String`	`getFromNative(long i)` Returns a value at index i.
`int`	`getInt(long i)` Returns an int value at index i.
`int[]`	`getIntData()` If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns int data.
`int[]`	`getIntData(int[] a, long startPos, long endPos, long step)` If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object.
`long`	`getLong(long i)` Returns a long value at index i.
`long[]`	`getLongData()` If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns long data.
`long[]`	`getLongData(long[] a, long startPos, long endPos, long step)` If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object.
`int`	`getMaxStringLength()` Returns maximal length of each element.
`short`	`getShort(long i)` Returns a short value at index i.
`short[]`	`getShortData()` If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns short data.
`short[]`	`getShortData(short[] a, long startPos, long endPos, long step)` If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object.
`short`	`getUnsignedByte(long i)` Returns an unsigned byte value at index i.
`int`	`hashCode()`
`void`	`set_safe(long i, Object o)` Sets a value at index i.
`void`	`set(long i, Object o)` Sets a value at index i.
`void`	`setBoolean(long i, boolean value)` Sets a boolean value at index i.
`void`	`setByte(long i, byte value)` Sets a byte value at index i.
`void`	`setDouble(long i, double value)` Sets a double value at index i.
`void`	`setFloat(long i, float value)` Sets a float value at index i.
`void`	`setInt(long i, int value)` Sets an int value at index i.
`void`	`setLong(long i, long value)` Sets a long value at index i.
`void`	`setShort(long i, short value)` Sets a short value at index i.
`void`	`setToNative(long i, Object o)` Sets a value at index i.
`void`	`setUnsignedByte(long i, short value)` Sets an unsigned byte value at index i.

Methods inherited from class pl.edu.icm.jlargearrays.LargeArray
get_safe, getBoolean_safe, getByte_safe, getDouble_safe, getFloat_safe, getInt_safe, getLong_safe, getMaxSizeOf32bitArray, getShort_safe, getType, getUnsignedByte_safe, isConstant, isLarge, isNumeric, length, nativePointer, setBoolean_safe, setByte_safe, setDouble_safe, setFloat_safe, setInt_safe, setLong_safe, setMaxSizeOf32bitArray, setShort_safe, setUnsignedByte_safe, zeroNativeMemory

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StringLargeArray
```
public StringLargeArray(long length)
```
    Creates new instance of this class. The maximal string length is set to 100.
    
    Parameters:
    
    length - number of elements
  - StringLargeArray
```
public StringLargeArray(long length,
                        int maxStringLength)
```
    Creates new instance of this class.
    
    Parameters:
    
    length - number of elements
    
    maxStringLength - maximal length of the string, it is ignored when number of elements is smaller than LargeArray.getMaxSizeOf43bitArray().
  - StringLargeArray
```
public StringLargeArray(long length,
                        int maxStringLength,
                        boolean zeroNativeMemory)
```
    Creates new instance of this class.
    
    Parameters:
    
    length - number of elements
    
    maxStringLength - maximal length of the string, it is ignored when number of elements is smaller than LargeArray.getMaxSizeOf43bitArray().
    
    zeroNativeMemory - if true, then the native memory is zeroed.
  - StringLargeArray
```
public StringLargeArray(long length,
                        String constantValue)
```
    Creates a constant array.
    
    Parameters:
    
    length - number of elements
    
    constantValue - value
  - StringLargeArray
```
public StringLargeArray(String[] data)
```
    Creates new instance of this class.
    
    Parameters:
    
    data - data array, this reference is used internally.
- Method Detail
  - clone
```
public StringLargeArray clone()
```
    Returns a deep copy of this instance. (The elements themselves are copied.)
    
    Overrides:
    
    clone in class LargeArray
    
    Returns:
    
    a clone of this instance
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class LargeArray
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class LargeArray
  - get
```
public final String get(long i)
```
    Description copied from class: LargeArray
    
    Returns a value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    get in class LargeArray
    
    Parameters:
    
    i - an index
    
    Returns:
    
    a value at index i.
  - getFromNative
```
public final String getFromNative(long i)
```
    Description copied from class: LargeArray
    
    Returns a value at index i. Array bounds are not checked. If isLarge() returns false for a given array or the index argument is invalid, then calling this method will cause JVM crash.
    
    Specified by:
    
    getFromNative in class LargeArray
    
    Parameters:
    
    i - index
    
    Returns:
    
    a value at index i. The type of returned value is the same as the type of this array.
  - getBoolean
```
public final boolean getBoolean(long i)
```
    Description copied from class: LargeArray
    
    Returns a boolean value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    getBoolean in class LargeArray
    
    Parameters:
    
    i - an index
    
    Returns:
    
    a boolean value at index i.
  - getByte
```
public final byte getByte(long i)
```
    Description copied from class: LargeArray
    
    Returns a signed byte value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    getByte in class LargeArray
    
    Parameters:
    
    i - an index
    
    Returns:
    
    a value at index i.
  - getUnsignedByte
```
public final short getUnsignedByte(long i)
```
    Description copied from class: LargeArray
    
    Returns an unsigned byte value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    getUnsignedByte in class LargeArray
    
    Parameters:
    
    i - an index
    
    Returns:
    
    a value at index i.
  - getShort
```
public final short getShort(long i)
```
    Description copied from class: LargeArray
    
    Returns a short value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    getShort in class LargeArray
    
    Parameters:
    
    i - an index
    
    Returns:
    
    a value at index i.
  - getInt
```
public final int getInt(long i)
```
    Description copied from class: LargeArray
    
    Returns an int value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    getInt in class LargeArray
    
    Parameters:
    
    i - an index
    
    Returns:
    
    a value at index i.
  - getLong
```
public final long getLong(long i)
```
    Description copied from class: LargeArray
    
    Returns a long value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    getLong in class LargeArray
    
    Parameters:
    
    i - an index
    
    Returns:
    
    a value at index i.
  - getFloat
```
public final float getFloat(long i)
```
    Description copied from class: LargeArray
    
    Returns a float value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    getFloat in class LargeArray
    
    Parameters:
    
    i - an index
    
    Returns:
    
    a value at index i.
  - getDouble
```
public final double getDouble(long i)
```
    Description copied from class: LargeArray
    
    Returns a double value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    getDouble in class LargeArray
    
    Parameters:
    
    i - an index
    
    Returns:
    
    a value at index i.
  - getData
```
public final String[] getData()
```
    Description copied from class: LargeArray
    
    Returns a reference to the internal data array. For constant arrays the length of the returned array is always equal to 1. If isLarge() returns true, then this method returns null.
    
    Specified by:
    
    getData in class LargeArray
    
    Returns:
    
    reference to the internal data array or null
  - getBooleanData
```
public final boolean[] getBooleanData()
```
    Description copied from class: LargeArray
    
    If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns boolean data. Otherwise, it returns null.
    
    Specified by:
    
    getBooleanData in class LargeArray
    
    Returns:
    
    an array containing the elements of this object or null
  - getBooleanData
```
public final boolean[] getBooleanData(boolean[] a,
                                      long startPos,
                                      long endPos,
                                      long step)
```
    Description copied from class: LargeArray
    
    If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object. Otherwise, it returns null. If (endPos - startPos) / step is smaller or equal to a.length, it is returned therein. Otherwise, a new array is allocated and returned. Array bounds are checked.
    
    Specified by:
    
    getBooleanData in class LargeArray
    
    Parameters:
    
    a - the array into which the elements are to be stored, if it is big enough; otherwise, a new array of is allocated for this purpose.
    
    startPos - starting position (included)
    
    endPos - ending position (excluded)
    
    step - step size
    
    Returns:
    
    an array containing the elements of this object or null
  - getByteData
```
public final byte[] getByteData()
```
    Description copied from class: LargeArray
    
    If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns byte data. Otherwise, it returns null.
    
    Specified by:
    
    getByteData in class LargeArray
    
    Returns:
    
    an array containing the elements of this object or null
  - getByteData
```
public final byte[] getByteData(byte[] a,
                                long startPos,
                                long endPos,
                                long step)
```
    Description copied from class: LargeArray
    
    If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object. Otherwise, it returns null. If (endPos - startPos) / step is smaller or equal to a.length, it is returned therein. Otherwise, a new array is allocated and returned. Array bounds are checked.
    
    Specified by:
    
    getByteData in class LargeArray
    
    Parameters:
    
    a - the array into which the elements are to be stored, if it is big enough; otherwise, a new array of is allocated for this purpose.
    
    startPos - starting position (included)
    
    endPos - ending position (excluded)
    
    step - step size
    
    Returns:
    
    an array containing the elements of this object or null
  - getShortData
```
public final short[] getShortData()
```
    Description copied from class: LargeArray
    
    If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns short data. Otherwise, it returns null.
    
    Specified by:
    
    getShortData in class LargeArray
    
    Returns:
    
    an array containing the elements of this object or null
  - getShortData
```
public final short[] getShortData(short[] a,
                                  long startPos,
                                  long endPos,
                                  long step)
```
    Description copied from class: LargeArray
    
    If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object. Otherwise, it returns null. If (endPos - startPos) / step is smaller or equal to a.length, it is returned therein. Otherwise, a new array is allocated and returned. Array bounds are checked.
    
    Specified by:
    
    getShortData in class LargeArray
    
    Parameters:
    
    a - the array into which the elements are to be stored, if it is big enough; otherwise, a new array of is allocated for this purpose.
    
    startPos - starting position (included)
    
    endPos - ending position (excluded)
    
    step - step size
    
    Returns:
    
    an array containing the elements of this object or null
  - getIntData
```
public final int[] getIntData()
```
    Description copied from class: LargeArray
    
    If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns int data. Otherwise, it returns null.
    
    Specified by:
    
    getIntData in class LargeArray
    
    Returns:
    
    an array containing the elements of this object or null
  - getIntData
```
public final int[] getIntData(int[] a,
                              long startPos,
                              long endPos,
                              long step)
```
    Description copied from class: LargeArray
    
    If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object. Otherwise, it returns null. If (endPos - startPos) / step is smaller or equal to a.length, it is returned therein. Otherwise, a new array is allocated and returned. Array bounds are checked.
    
    Specified by:
    
    getIntData in class LargeArray
    
    Parameters:
    
    a - the array into which the elements are to be stored, if it is big enough; otherwise, a new array of is allocated for this purpose.
    
    startPos - starting position (included)
    
    endPos - ending position (excluded)
    
    step - step size
    
    Returns:
    
    an array containing the elements of this object or null
  - getLongData
```
public final long[] getLongData()
```
    Description copied from class: LargeArray
    
    If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns long data. Otherwise, it returns null.
    
    Specified by:
    
    getLongData in class LargeArray
    
    Returns:
    
    an array containing the elements of this object or null
  - getLongData
```
public final long[] getLongData(long[] a,
                                long startPos,
                                long endPos,
                                long step)
```
    Description copied from class: LargeArray
    
    If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object. Otherwise, it returns null. If (endPos - startPos) / step is smaller or equal to a.length, it is returned therein. Otherwise, a new array is allocated and returned. Array bounds are checked.
    
    Specified by:
    
    getLongData in class LargeArray
    
    Parameters:
    
    a - the array into which the elements are to be stored, if it is big enough; otherwise, a new array of is allocated for this purpose.
    
    startPos - starting position (included)
    
    endPos - ending position (excluded)
    
    step - step size
    
    Returns:
    
    an array containing the elements of this object or null
  - getFloatData
```
public final float[] getFloatData()
```
    Description copied from class: LargeArray
    
    If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns float data. Otherwise, it returns null.
    
    Specified by:
    
    getFloatData in class LargeArray
    
    Returns:
    
    an array containing the elements of this object or null
  - getFloatData
```
public final float[] getFloatData(float[] a,
                                  long startPos,
                                  long endPos,
                                  long step)
```
    Description copied from class: LargeArray
    
    If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object. Otherwise, it returns null. If (endPos - startPos) / step is smaller or equal to a.length, it is returned therein. Otherwise, a new array is allocated and returned. Array bounds are checked.
    
    Specified by:
    
    getFloatData in class LargeArray
    
    Parameters:
    
    a - the array into which the elements are to be stored, if it is big enough; otherwise, a new array of is allocated for this purpose.
    
    startPos - starting position (included)
    
    endPos - ending position (excluded)
    
    step - step size
    
    Returns:
    
    an array containing the elements of this object or null
  - getDoubleData
```
public final double[] getDoubleData()
```
    Description copied from class: LargeArray
    
    If the size of the array is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns double data. Otherwise, it returns null.
    
    Specified by:
    
    getDoubleData in class LargeArray
    
    Returns:
    
    an array containing the elements of this object or null
  - getDoubleData
```
public final double[] getDoubleData(double[] a,
                                    long startPos,
                                    long endPos,
                                    long step)
```
    Description copied from class: LargeArray
    
    If (endPos - startPos) / step is smaller than LargeArray.LARGEST_SUBARRAY, then this method returns selected elements of this object. Otherwise, it returns null. If (endPos - startPos) / step is smaller or equal to a.length, it is returned therein. Otherwise, a new array is allocated and returned. Array bounds are checked.
    
    Specified by:
    
    getDoubleData in class LargeArray
    
    Parameters:
    
    a - the array into which the elements are to be stored, if it is big enough; otherwise, a new array of is allocated for this purpose.
    
    startPos - starting position (included)
    
    endPos - ending position (excluded)
    
    step - step size
    
    Returns:
    
    an array containing the elements of this object or null
  - setToNative
```
public final void setToNative(long i,
                              Object o)
```
    Description copied from class: LargeArray
    
    Sets a value at index i. Array bounds are not checked. If isLarge() returns false for a given array or the index argument is invalid, then calling this method will cause JVM crash.
    
    Specified by:
    
    setToNative in class LargeArray
    
    Parameters:
    
    i - index
    
    o - value to set
  - set
```
public final void set(long i,
                      Object o)
```
    Description copied from class: LargeArray
    
    Sets a value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Overrides:
    
    set in class LargeArray
    
    Parameters:
    
    i - index
    
    o - value to set
  - set_safe
```
public final void set_safe(long i,
                           Object o)
```
    Description copied from class: LargeArray
    
    Sets a value at index i. Array bounds are checked.
    
    Overrides:
    
    set_safe in class LargeArray
    
    Parameters:
    
    i - index
    
    o - value to set
  - setBoolean
```
public final void setBoolean(long i,
                             boolean value)
```
    Description copied from class: LargeArray
    
    Sets a boolean value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    setBoolean in class LargeArray
    
    Parameters:
    
    i - index
    
    value - value to set
  - setByte
```
public final void setByte(long i,
                          byte value)
```
    Description copied from class: LargeArray
    
    Sets a byte value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    setByte in class LargeArray
    
    Parameters:
    
    i - index
    
    value - value to set
  - setUnsignedByte
```
public final void setUnsignedByte(long i,
                                  short value)
```
    Description copied from class: LargeArray
    
    Sets an unsigned byte value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    setUnsignedByte in class LargeArray
    
    Parameters:
    
    i - index
    
    value - value to set
  - setShort
```
public final void setShort(long i,
                           short value)
```
    Description copied from class: LargeArray
    
    Sets a short value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    setShort in class LargeArray
    
    Parameters:
    
    i - index
    
    value - value to set
  - setInt
```
public final void setInt(long i,
                         int value)
```
    Description copied from class: LargeArray
    
    Sets an int value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    setInt in class LargeArray
    
    Parameters:
    
    i - index
    
    value - value to set
  - setLong
```
public final void setLong(long i,
                          long value)
```
    Description copied from class: LargeArray
    
    Sets a long value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    setLong in class LargeArray
    
    Parameters:
    
    i - index
    
    value - value to set
  - setFloat
```
public final void setFloat(long i,
                           float value)
```
    Description copied from class: LargeArray
    
    Sets a float value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    setFloat in class LargeArray
    
    Parameters:
    
    i - index
    
    value - value to set
  - setDouble
```
public final void setDouble(long i,
                            double value)
```
    Description copied from class: LargeArray
    
    Sets a double value at index i. Array bounds are not checked. Calling this method with invalid index argument will cause JVM crash.
    
    Specified by:
    
    setDouble in class LargeArray
    
    Parameters:
    
    i - index
    
    value - value to set
  - getMaxStringLength
```
public int getMaxStringLength()
```
    Returns maximal length of each element.
    
    Returns:
    
    maximal length of each element

Class StringLargeArray

Nested Class Summary

Nested classes/interfaces inherited from class pl.edu.icm.jlargearrays.LargeArray

Field Summary

Fields inherited from class pl.edu.icm.jlargearrays.LargeArray

Constructor Summary

Method Summary

Methods inherited from class pl.edu.icm.jlargearrays.LargeArray

Methods inherited from class java.lang.Object

Constructor Detail

StringLargeArray

StringLargeArray

StringLargeArray

StringLargeArray

StringLargeArray

Method Detail

clone

equals

hashCode

get

getFromNative

getBoolean

getByte

getUnsignedByte

getShort

getInt

getLong

getFloat

getDouble

getData

getBooleanData

getBooleanData

getByteData

getByteData

getShortData

getShortData

getIntData

getIntData

getLongData

getLongData

getFloatData

getFloatData

getDoubleData

getDoubleData

setToNative

set

set_safe

setBoolean

setByte

setUnsignedByte

setShort

setInt

setLong

setFloat

setDouble

getMaxStringLength