Package io.permazen.encoding

Class CharacterArrayEncoding

java.lang.Object
io.permazen.encoding.AbstractEncoding<T>
io.permazen.encoding.ArrayEncoding<char[],Character>
io.permazen.encoding.CharacterArrayEncoding
All Implemented Interfaces:
Encoding<char[]>, NaturalSortAware, Serializable, Comparator<char[]>
public class CharacterArrayEncoding extends ArrayEncoding<char[],Character>
char[] array type. Does not support null arrays.

We use the same encoding as StringEncoding.

See Also:

  • Constructor Details

    • CharacterArrayEncoding

      public CharacterArrayEncoding(EncodingId encodingId)

  • Method Details

    • withEncodingId

      public CharacterArrayEncoding 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 char[] 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, char[] 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

    • hasPrefix0x00

      public boolean hasPrefix0x00()
      Description copied from interface: Encoding
      Determine whether any of this encoding's encoded values start with a 0x00 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 0x00 exists

    • 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(char[] array)
      Description copied from class: ArrayEncoding
      Get the length of the given array.
      Specified by:
      getArrayLength in class ArrayEncoding<char[],Character>
      Parameters:
      array - non-null array
      Returns:
      array length

    • getArrayElement

      protected Character getArrayElement(char[] array, int index)
      Description copied from class: ArrayEncoding
      Get an element from the given array.
      Specified by:
      getArrayElement in class ArrayEncoding<char[],Character>
      Parameters:
      array - non-null array
      index - index of target element in array
      Returns:
      array element at index index

    • createArray

      protected char[] createArray(List<Character> elements)
      Description copied from class: ArrayEncoding
      Create a new array instance containing the given elements.
      Specified by:
      createArray in class ArrayEncoding<char[],Character>
      Parameters:
      elements - content for the new array
      Returns:
      newly created array

    • convert

      public <S> char[] convert(Encoding<S> type, S value)
      Description copied from interface: Encoding
      Attempt to convert a value from the given Encoding into a value of this Encoding.

      For a non-null value, the implementation in Encoding first checks whether the value is already a valid value for this encoding; if so, the value is returned. Otherwise, it invokes encoding.toString(value) to convert value into a String, and then attempts to parse that string via this.fromString(); if the parse fails, an IllegalArgumentException is thrown. Note this means that any value will convert successfully to a String, as long as it doesn't contain an invalid escape sequence (see StringEncoding.toString(java.lang.String)).

      If value is null, the implementation in Encoding returns null, unless this encoding does not support null values, in which case an IllegalArgumentException is thrown.

      Permazen's built-in encodings include the following conversions:

      • Non-boolean Primitive types:
        • Convert from other non-boolean primitive types as if by the corresponding Java cast
        • Convert from boolean by converting to zero (if false) or one (if true)
      • Boolean: converts from other primitive types as if by value != 0
      • A char[] array and a String are convertible to each other
      • A char and a String of length one are convertible to each other (other Strings are not)
      • Arrays: converted by converting each array element individually (if possible)
      Specified by:
      convert in interface Encoding<char[]>
      Overrides:
      convert in class ArrayEncoding<char[],Character>
      Type Parameters:
      S - source encoding
      Parameters:
      type - the Encoding of value
      value - the value to convert
      Returns:
      value converted to this instance's type