io.permazen.core.type

Class BooleanArrayType

java.lang.Object

io.permazen.core.FieldType<T>

io.permazen.core.type.NonNullFieldType<T>

io.permazen.core.type.ArrayType<boolean[],Boolean>

io.permazen.core.type.BooleanArrayType

All Implemented Interfaces:

Serializable, Comparator<boolean[]>

public class BooleanArrayType
extends ArrayType<boolean[],Boolean>

boolean[] array type. Does not support null arrays.

Each boolean value is encoded in two bits: end of array (00), false (01), or true (10). Four bit pairs are stored in each encoded byte, starting with the high-order bit pair.

See Also:

Serialized Form

Field Summary

Fields inherited from class io.permazen.core.type.ArrayType

ARRAY_SUFFIX, MAX_DIMENSIONS

Fields inherited from class io.permazen.core.FieldType

name, NAME_PATTERN, REFERENCE_TYPE_NAME, signature, typeToken

Constructor Summary

Constructors

Constructor and Description
BooleanArrayType()

Method Summary

Modifier and Type	Method and Description
protected boolean[]	createArray(List<Boolean> elements) Create a new array instance containing the given elements.
protected Boolean	getArrayElement(boolean[] array, int index) Get an element from the given array.
protected int	getArrayLength(boolean[] array) Get the length of the given array.
boolean	hasPrefix0xff() Determine whether any of this field type's encoded values start with a 0xff byte.
boolean[]	read(ByteReader reader) Read a value from the given input.
void	skip(ByteReader reader) Read and discard a value from the given input.
void	write(ByteWriter writer, boolean[] array) Write a value to the given output.

Methods inherited from class io.permazen.core.type.ArrayType

compare, convert, equals, fromParseableString, getDimensions, hashCode, toParseableString

Methods inherited from class io.permazen.core.type.NonNullFieldType

validate

Methods inherited from class io.permazen.core.FieldType

fromString, genericizeForIndex, getDefaultValue, getDefaultValueObject, getEncodingSignature, getKeyRange, getName, getTypeToken, hasPrefix0x00, toString, toString, validateAndWrite

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

BooleanArrayType

public BooleanArrayType()

Method Detail

read

public boolean[] read(ByteReader reader)

Description copied from class: FieldType

Read a value from the given input.

Specified by:

read in class FieldType<boolean[]>

Parameters:

reader - byte input

Returns:

field value (possibly null)

write

public void write(ByteWriter writer,
                  boolean[] array)

Description copied from class: FieldType

Write a value to the given output.

Specified by:

write in class FieldType<boolean[]>

Parameters:

writer - byte output

array - value to write (possibly null)

skip

public void skip(ByteReader reader)

Description copied from class: FieldType

Read and discard a value from the given input.

Specified by:

skip in class FieldType<boolean[]>

Parameters:

reader - byte input

hasPrefix0xff

public boolean hasPrefix0xff()

Description copied from class: FieldType

Determine whether any of this field type's encoded values start with a 0xff byte. Certain optimizations are possible when this is not the case. It is safe for this method to always return true.

Note: changing the return value of this method usually means changing the binary encoding, resulting in an incompatible type.

The implementation in FieldType returns true.

Overrides:

hasPrefix0xff in class FieldType<boolean[]>

Returns:

true if an encoded value starting with 0xff exists

getArrayLength

protected int getArrayLength(boolean[] array)

Description copied from class: ArrayType

Get the length of the given array.

Specified by:

getArrayLength in class ArrayType<boolean[],Boolean>

Parameters:

array - non-null array

Returns:

array length

getArrayElement

protected Boolean getArrayElement(boolean[] array,
                                  int index)

Description copied from class: ArrayType

Get an element from the given array.

Specified by:

getArrayElement in class ArrayType<boolean[],Boolean>

Parameters:

array - non-null array

index - index of target element in array

Returns:

array element at index index

createArray

protected boolean[] createArray(List<Boolean> elements)

Description copied from class: ArrayType

Create a new array instance containing the given elements.

Specified by:

createArray in class ArrayType<boolean[],Boolean>

Parameters:

elements - content for the new array

Returns:

newly created array