org.openzen.zengarden.arrays

Interface ArrayFunctions<A>

Type Parameters:

A - array type (such as int[], String[], ...)

All Known Implementing Classes:

ByteArrayFunctions, DoubleArrayFunctions, FloatArrayFunctions, IntArrayFunctions, LongArrayFunctions, ObjectArrayFunctions, ShortArrayFunctions, StringArrayFunctions, VarIntArrayFunctions, VarLongArrayFunctions, VarUIntArrayFunctions, VarULongArrayFunctions

public interface ArrayFunctions<A>

Generic interface for array operations.

Method Summary

Modifier and Type	Method and Description
A	concat(A array1, A array2) Concatenates two arrays into one and returns it.
void	copyArray(A from, int fromOffset, A to, int toOffset, int length) Copies part of the first array to the second array.
A	copyOfRange(A original, int from, int to) Copies the specified range.
boolean	endsWith(A array, A subarray) Checks if array[length - subarray.length:] == subarray.
boolean	equals(A array1, A array2) Checks if the two arrays have the same content.
boolean	equals(A array1, int array1Index, A array2, int array2Index) Checks if array1[array1Index] == array2[array2Index].
int	getCommonPrefixLength(A array1, A array2) Determines the longest common prefix, that is, the number of items at the start of the arrays that are equal.
int	getCommonSuffixLength(A array1, A array2) Determines the longest common suffix, that is, the number of items at the end of the arrays that are equal.
int	getLength(A value) Gets the length of the given array.
A	newArray(int length) Constructs a new array of the given length.
A	read(BytesDataInput input) Reads an array from the given input stream.
A	read(DataInput input) Reads an array from the given input stream.
A	readRaw(BytesDataInput input, int length) Reads an array from the given input stream.
A	readRaw(DataInput input, int length) Reads an array from the given input stream.
boolean	startsWith(A array, A subarray) Checks if array[:subarray.length] == subarray.
void	write(BytesDataOutput output, A value) Writes the contents of the given array to the output stream.
void	write(DataOutput output, A value) Writes the contents of the given array to the output stream.
void	writeRaw(BytesDataOutput output, A value) Writes the contents of the given array to the output stream.
void	writeRaw(DataOutput output, A value) Writes the contents of the given array to the output stream.

Method Detail

newArray

A newArray(int length)

Constructs a new array of the given length.

Parameters:

length - array length

Returns:

newly created array

getLength

int getLength(A value)

Gets the length of the given array.

Parameters:

value - array value

Returns:

array length

equals

boolean equals(A array1,
               A array2)

Checks if the two arrays have the same content.

Parameters:

array1 - first array

array2 - second array

Returns:

true if the arrays are equivalent, false otherwise

startsWith

boolean startsWith(A array,
                   A subarray)

Checks if array[:subarray.length] == subarray.

Parameters:

array - array to check

subarray - array prefix to check for

Returns:

true if the given array starts with the given subarray

endsWith

boolean endsWith(A array,
                 A subarray)

Checks if array[length - subarray.length:] == subarray.

Parameters:

array - array to check

subarray - array suffix to check for

Returns:

true if the given array ends with the given subarray

getCommonSuffixLength

int getCommonSuffixLength(A array1,
                          A array2)

Determines the longest common suffix, that is, the number of items at the end of the arrays that are equal.

Parameters:

array1 - first array

array2 - second array

Returns:

longest common suffix length

getCommonPrefixLength

int getCommonPrefixLength(A array1,
                          A array2)

Determines the longest common prefix, that is, the number of items at the start of the arrays that are equal.

Parameters:

array1 - first array

array2 - second array

Returns:

longest common prefix length

copyOfRange

A copyOfRange(A original,
              int from,
              int to)

Copies the specified range. Copies the range, that is, changing the contents of the result will not change the original array.

Parameters:

original - array to copy from

from - range start index

to - range end index

Returns:

array copy

copyArray

void copyArray(A from,
               int fromOffset,
               A to,
               int toOffset,
               int length)

Copies part of the first array to the second array.

Parameters:

from - array to copy from

fromOffset - offset to copy from

to - array to copy tco

toOffset - offset to copy to

length - number of items to copy

equals

boolean equals(A array1,
               int array1Index,
               A array2,
               int array2Index)

Checks if array1[array1Index] == array2[array2Index].

Parameters:

array1 - first array

array1Index - first array index

array2 - second array

array2Index - second array index

Returns:

true if the array contents at the given positions are equal

concat

A concat(A array1,
         A array2)

Concatenates two arrays into one and returns it.

Parameters:

array1 - first array

array2 - second array

Returns:

concatenated array

write

void write(DataOutput output,
           A value)
    throws java.io.IOException

Writes the contents of the given array to the output stream. Includes the array length.

Parameters:

output - stream to write to

value - array to be written

Throws:

java.io.IOException - if an I/O error occurs

writeRaw

void writeRaw(DataOutput output,
              A value)
       throws java.io.IOException

Writes the contents of the given array to the output stream. Excludes the array length.

Parameters:

output - stream to write to

value - array to be written

Throws:

java.io.IOException - if an I/O error occurs

write

void write(BytesDataOutput output,
           A value)

Writes the contents of the given array to the output stream. Includes the array length.

Parameters:

output - stream to write to

value - array to be written

writeRaw

void writeRaw(BytesDataOutput output,
              A value)

Writes the contents of the given array to the output stream. Excludes the array length.

Parameters:

output - stream to write to

value - array to be written

read

A read(DataInput input)
throws java.io.IOException

Reads an array from the given input stream. The input must also contain the array length as written by the write method.

Parameters:

input - stream to read from

Returns:

array that has been read

Throws:

java.io.IOException - if an I/O error occurs

readRaw

A readRaw(DataInput input,
          int length)
   throws java.io.IOException

Reads an array from the given input stream. The input must not contain the array length; that is, it should use the format as used by writeRaw.

Parameters:

input - stream to read from

length - array length

Returns:

array that has been read

Throws:

java.io.IOException - if an I/O error occurs

read

A read(BytesDataInput input)

Reads an array from the given input stream. The input must also contain the array length as written by the write method.

Parameters:

input - stream to read from

Returns:

array that has been read

readRaw

A readRaw(BytesDataInput input,
          int length)

Reads an array from the given input stream. The input must not contain the array length; that is, it should use the format as used by writeRaw.

Parameters:

input - stream to read from

length - array length

Returns:

array that has been read