Package io.bytestreams.codec.core

Class PairCodec<A,B>

java.lang.Object
io.bytestreams.codec.core.PairCodec<A,B>
Type Parameters:
A - the type of the first value
B - the type of the second value
All Implemented Interfaces:
Codec<Pair<A,B>>, Inspectable<Pair<A,B>>
public class PairCodec<A,B> extends Object implements Codec<Pair<A,B>>, Inspectable<Pair<A,B>>
A codec that encodes and decodes a pair of values sequentially.

The wire format is [first][second]. Use as(BiFunction, Function, Function) to map the pair to a domain type without exposing the internal representation.

Example usage: 


 Codec<Rectangle> codec = Codecs.pair(Codecs.uint8(), Codecs.uint8())
     .as(Rectangle::new, r -> r.width, r -> r.height);

  • Method Details

    • encode

      public EncodeResult encode(Pair<A,B> value, OutputStream output) throws IOException
      Description copied from interface: Codec
      Encodes the given value and writes it to the output stream.
      Specified by:
      encode in interface Codec<A>
      Parameters:
      value - the value to encode
      output - the output stream to write the encoded bytes to
      Returns:
      the encode result containing logical count and bytes written
      Throws:
      IOException - if an I/O error occurs during encoding

    • decode

      public Pair<A,B> decode(InputStream input) throws IOException
      Description copied from interface: Codec
      Decodes a value from the input stream.
      Specified by:
      decode in interface Codec<A>
      Parameters:
      input - the input stream to read the encoded bytes from
      Returns:
      the decoded value
      Throws:
      IOException - if an I/O error occurs during decoding

    • inspect

      public Object inspect(Pair<A,B> value)
      Description copied from interface: Inspectable
      Returns a structured representation of the given value.
      Specified by:
      inspect in interface Inspectable<A>
      Parameters:
      value - the decoded value to inspect
      Returns:
      a structured representation (Map, List, or scalar)

    • as

      public <V> Codec<V> as(BiFunction<A,B,V> constructor, Function<V,A> getFirst, Function<V,B> getSecond)
      Maps this pair codec to a domain type.
      Type Parameters:
      V - the domain type
      Parameters:
      constructor - constructs the domain type from the two values
      getFirst - extracts the first value from the domain type
      getSecond - extracts the second value from the domain type
      Returns:
      a codec for the domain type
      Throws:
      NullPointerException - if any argument is null