org.openzen.zengarden.arrays

Class ByteArrayFunctions

java.lang.Object

org.openzen.zengarden.arrays.ByteArrayFunctions

All Implemented Interfaces:

ArrayFunctions<byte[]>

public class ByteArrayFunctions
extends java.lang.Object
implements ArrayFunctions<byte[]>

byte[] implementation of ArrayFunctions.

Field Summary

Fields

Modifier and Type	Field and Description
static ByteArrayFunctions	INSTANCE

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ByteArrayFunctions INSTANCE

Method Detail

newArray

public byte[] newArray(int length)

Description copied from interface: ArrayFunctions

Constructs a new array of the given length.

Specified by:

newArray in interface ArrayFunctions<byte[]>

Parameters:

length - array length

Returns:

newly created array

getLength

public int getLength(byte[] value)

Description copied from interface: ArrayFunctions

Gets the length of the given array.

Specified by:

getLength in interface ArrayFunctions<byte[]>

Parameters:

value - array value

Returns:

array length

equals

public boolean equals(byte[] array1,
                      byte[] array2)

Description copied from interface: ArrayFunctions

Checks if the two arrays have the same content.

Specified by:

equals in interface ArrayFunctions<byte[]>

Parameters:

array1 - first array

array2 - second array

Returns:

true if the arrays are equivalent, false otherwise

concat

public byte[] concat(byte[] array1,
                     byte[] array2)

Description copied from interface: ArrayFunctions

Concatenates two arrays into one and returns it.

Specified by:

concat in interface ArrayFunctions<byte[]>

Parameters:

array1 - first array

array2 - second array

Returns:

concatenated array

startsWith

public boolean startsWith(byte[] array,
                          byte[] subarray)

Description copied from interface: ArrayFunctions

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

Specified by:

startsWith in interface ArrayFunctions<byte[]>

Parameters:

array - array to check

subarray - array prefix to check for

Returns:

true if the given array starts with the given subarray

endsWith

public boolean endsWith(byte[] array,
                        byte[] subarray)

Description copied from interface: ArrayFunctions

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

Specified by:

endsWith in interface ArrayFunctions<byte[]>

Parameters:

array - array to check

subarray - array suffix to check for

Returns:

true if the given array ends with the given subarray

getCommonSuffixLength

public int getCommonSuffixLength(byte[] array1,
                                 byte[] array2)

Description copied from interface: ArrayFunctions

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

Specified by:

getCommonSuffixLength in interface ArrayFunctions<byte[]>

Parameters:

array1 - first array

array2 - second array

Returns:

longest common suffix length

getCommonPrefixLength

public int getCommonPrefixLength(byte[] array1,
                                 byte[] array2)

Description copied from interface: ArrayFunctions

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

Specified by:

getCommonPrefixLength in interface ArrayFunctions<byte[]>

Parameters:

array1 - first array

array2 - second array

Returns:

longest common prefix length

copyOfRange

public byte[] copyOfRange(byte[] original,
                          int from,
                          int to)

Description copied from interface: ArrayFunctions

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

Specified by:

copyOfRange in interface ArrayFunctions<byte[]>

Parameters:

original - array to copy from

from - range start index

to - range end index

Returns:

array copy

copyArray

public void copyArray(byte[] from,
                      int fromOffset,
                      byte[] to,
                      int toOffset,
                      int length)

Description copied from interface: ArrayFunctions

Copies part of the first array to the second array.

Specified by:

copyArray in interface ArrayFunctions<byte[]>

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

public boolean equals(byte[] array1,
                      int array1Index,
                      byte[] array2,
                      int array2Index)

Description copied from interface: ArrayFunctions

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

Specified by:

equals in interface ArrayFunctions<byte[]>

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

write

public void write(DataOutput output,
                  byte[] value)
           throws java.io.IOException

Description copied from interface: ArrayFunctions

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

Specified by:

write in interface ArrayFunctions<byte[]>

Parameters:

output - stream to write to

value - array to be written

Throws:

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

writeRaw

public void writeRaw(DataOutput output,
                     byte[] value)
              throws java.io.IOException

Description copied from interface: ArrayFunctions

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

Specified by:

writeRaw in interface ArrayFunctions<byte[]>

Parameters:

output - stream to write to

value - array to be written

Throws:

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

write

public void write(BytesDataOutput output,
                  byte[] value)

Description copied from interface: ArrayFunctions

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

Specified by:

write in interface ArrayFunctions<byte[]>

Parameters:

output - stream to write to

value - array to be written

writeRaw

public void writeRaw(BytesDataOutput output,
                     byte[] value)

Description copied from interface: ArrayFunctions

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

Specified by:

writeRaw in interface ArrayFunctions<byte[]>

Parameters:

output - stream to write to

value - array to be written

read

public byte[] read(DataInput input)
            throws java.io.IOException

Description copied from interface: ArrayFunctions

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

Specified by:

read in interface ArrayFunctions<byte[]>

Parameters:

input - stream to read from

Returns:

array that has been read

Throws:

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

readRaw

public byte[] readRaw(DataInput input,
                      int length)
               throws java.io.IOException

Description copied from interface: ArrayFunctions

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.

Specified by:

readRaw in interface ArrayFunctions<byte[]>

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

public byte[] read(BytesDataInput input)

Description copied from interface: ArrayFunctions

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

Specified by:

read in interface ArrayFunctions<byte[]>

Parameters:

input - stream to read from

Returns:

array that has been read

readRaw

public byte[] readRaw(BytesDataInput input,
                      int length)

Description copied from interface: ArrayFunctions

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.

Specified by:

readRaw in interface ArrayFunctions<byte[]>

Parameters:

input - stream to read from

length - array length

Returns:

array that has been read