Package io.permazen.encoding

Class IntegralArrayEncoding<T,E extends Number>

java.lang.Object
io.permazen.encoding.AbstractEncoding<T>
io.permazen.encoding.ArrayEncoding<T,E>
io.permazen.encoding.Base64ArrayEncoding<T,E>
io.permazen.encoding.IntegralArrayEncoding<T,E>
All Implemented Interfaces:
Encoding<T>, NaturalSortAware, Serializable, Comparator<T>
Direct Known Subclasses:
ByteArrayEncoding, IntegerArrayEncoding, LongArrayEncoding, ShortArrayEncoding
public abstract class IntegralArrayEncoding<T,E extends Number> extends Base64ArrayEncoding<T,E>
Support superclass for non-null integral primitive array encodings.

Null values are not supported by this class and there is no default value.

Arrays are encoded as a sequence of numerical values followed by 0x00, where each value is encoded via LongEncoder. Note, we take advantage of the fact that LongEncoder does not emit values starting with 0x00.

See Also:

  • Constructor Details

    • IntegralArrayEncoding

      protected IntegralArrayEncoding(IntegralEncoding<E> elementEncoding, Class<T> arrayClass)

  • Method Details

    • read

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

    • write

      public void write(ByteWriter writer, T 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.

      If the value skipped over is invalid, this method may, but is not required to, throw IllegalArgumentException.

      If the value skipped over is truncated, this method must throw IndexOutOfBoundsException.

      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.

      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.

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