Class ExternalizableCodec<T extends Externalizable>

java.lang.Object
io.deephaven.util.codec.ExternalizableCodec<T>
All Implemented Interfaces:
ObjectCodec<T>, ObjectDecoder<T>

public class ExternalizableCodec<T extends Externalizable> extends Object implements ObjectCodec<T>
  • Constructor Details

    • ExternalizableCodec

      public ExternalizableCodec(String className)
  • Method Details

    • encode

      public byte @NotNull [] encode(@Nullable T input)
      Description copied from interface: ObjectCodec
      Encode the specified input as an array of bytes. Note that it is up to the implementation how to encode null inputs. The use of a zero-length byte array is strongly encouraged.
      Specified by:
      encode in interface ObjectCodec<T extends Externalizable>
      Parameters:
      input - The input object, possibly null
      Returns:
      The output byte array
    • isNullable

      public boolean isNullable()
      Description copied from interface: ObjectCodec
      Does this codec support encoding of null values?
      Specified by:
      isNullable in interface ObjectCodec<T extends Externalizable>
      Returns:
      if null values are supported
    • getPrecision

      public int getPrecision()
      Description copied from interface: ObjectCodec
      If applicable, the maximum encodable precision. If precision is not applicable (i.e. for non-numeric types) this method should return zero.
      Specified by:
      getPrecision in interface ObjectCodec<T extends Externalizable>
      Returns:
      the numeric precision supported by this codec
    • getScale

      public int getScale()
      Description copied from interface: ObjectCodec
      If applicable, the maximum encodable scale. If scale is not applicable (i.e. for non-numeric types) this method should return zero.
      Specified by:
      getScale in interface ObjectCodec<T extends Externalizable>
      Returns:
      the numeric scale (digits after the decimal point) supported by this codec
    • decode

      @Nullable public T decode(byte @NotNull [] input, int offset, int length)
      Description copied from interface: ObjectDecoder
      Decode an object from an array of bytes.
      Specified by:
      decode in interface ObjectDecoder<T extends Externalizable>
      Parameters:
      input - The input byte array containing bytes to decode
      offset - The offset into the byte array to start decoding from
      length - The number of bytes to decode, starting at the offset
      Returns:
      The output object, possibly null
    • expectedObjectWidth

      public int expectedObjectWidth()
      Description copied from interface: ObjectDecoder
      What width byte array does this ObjectCodec expect to encode and decode?
      Specified by:
      expectedObjectWidth in interface ObjectDecoder<T extends Externalizable>
      Returns:
      VARIABLE_WIDTH_SENTINEL if the codec must encode and decode variable width columns, otherwise the fixed size of byte array that must be decoded and encoded.