Package io.bytestreams.codec.core

Record Class EncodeResult

java.lang.Object
java.lang.Record
io.bytestreams.codec.core.EncodeResult
Record Components:
count - the logical count in codec-specific units (e.g. code points, digits, items)
bytes - the number of bytes written to the output stream
public record EncodeResult(int count, int bytes) extends Record
Result of an encode operation, containing both the logical count and the byte count written.

The count field represents the number of logical units processed, whose meaning is codec-specific. For fixed-length codecs, this is the codec's configured length. For variable-length (stream) codecs, this is the actual number of units in the encoded value. Examples: code points for string codecs, hex digits for hex codecs, items for list codecs, bytes for binary, boolean, and number codecs.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final EncodeResult
    EMPTY
    An empty result representing zero count and zero bytes written.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EncodeResult(int count, int bytes)
    Creates a new EncodeResult.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    bytes()
    Returns the value of the bytes record component.
    int
    count()
    Returns the value of the count record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    static EncodeResult
    ofBytes(int bytes)
    Creates a result where the logical count equals the byte count.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • EMPTY

      public static final EncodeResult EMPTY
      An empty result representing zero count and zero bytes written.

  • Constructor Details

    • EncodeResult

      public EncodeResult(int count, int bytes)
      Creates a new EncodeResult.

  • Method Details

    • ofBytes

      public static EncodeResult ofBytes(int bytes)
      Creates a result where the logical count equals the byte count.
      Parameters:
      bytes - the number of bytes written (used as both count and bytes)
      Returns:
      an EncodeResult where count == bytes

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • count

      public int count()
      Returns the value of the count record component.
      Returns:
      the value of the count record component

    • bytes

      public int bytes()
      Returns the value of the bytes record component.
      Returns:
      the value of the bytes record component