Package io.permazen.encoding

Class BooleanArrayEncoding

java.lang.Object
io.permazen.encoding.AbstractEncoding<T>
io.permazen.encoding.ArrayEncoding<boolean[],Boolean>
io.permazen.encoding.BooleanArrayEncoding
All Implemented Interfaces:
Encoding<boolean[]>, NaturalSortAware, Serializable, Comparator<boolean[]>
public class BooleanArrayEncoding extends ArrayEncoding<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:

  • Constructor Details

    • BooleanArrayEncoding

      public BooleanArrayEncoding(EncodingId encodingId)

  • Method Details

    • withEncodingId

      public BooleanArrayEncoding withEncodingId(EncodingId encodingId)
      Description copied from interface: Encoding
      Build an encoding that has the given EncodingId but is otherwise equivalent to this encoding.

      If this encoding already has encodingId, then this method may (but is not required to) return this same instance.

      Parameters:
      encodingId - new encoding's EncodingId, or null for an anonymized encoding
      Returns:
      a version of this encoding with the given EncodingId

    • read

      public boolean[] read(ByteReader reader)
      Description copied from interface: Encoding
      Read a value from the given input.
      Parameters:
      reader - byte input
      Returns:
      field value (possibly null)

    • write

      public void write(ByteWriter writer, boolean[] array)
      Description copied from interface: Encoding
      Write a value to the given output.
      Parameters:
      writer - byte output
      array - value to write (possibly null)

    • skip

      public void skip(ByteReader reader)
      Description copied from interface: Encoding
      Read and discard a byte[] encoded value from the given input.
      Parameters:
      reader - byte input

    • hasPrefix0xff

      public boolean hasPrefix0xff()
      Description copied from interface: Encoding
      Determine whether any of this encoding'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 result of this method may result in an incompatible encoding if this encoding is wrapped in another class.

      The implementation in Encoding returns true.

      Returns:
      true if an encoded value starting with 0xff exists

    • getArrayLength

      protected int getArrayLength(boolean[] array)
      Description copied from class: ArrayEncoding
      Get the length of the given array.
      Specified by:
      getArrayLength in class ArrayEncoding<boolean[],Boolean>
      Parameters:
      array - non-null array
      Returns:
      array length

    • getArrayElement

      protected Boolean getArrayElement(boolean[] array, int index)
      Description copied from class: ArrayEncoding
      Get an element from the given array.
      Specified by:
      getArrayElement in class ArrayEncoding<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: ArrayEncoding
      Create a new array instance containing the given elements.
      Specified by:
      createArray in class ArrayEncoding<boolean[],Boolean>
      Parameters:
      elements - content for the new array
      Returns:
      newly created array