Package org.apache.beam.sdk.coders

Class VarLongCoder

java.lang.Object
org.apache.beam.sdk.coders.Coder<Long>
org.apache.beam.sdk.coders.StructuredCoder<Long>
org.apache.beam.sdk.coders.VarLongCoder
All Implemented Interfaces:
Serializable
public class VarLongCoder extends StructuredCoder<Long>
A Coder that encodes Longs using between 1 and 10 bytes. Negative numbers always take 10 bytes, so BigEndianLongCoder may be preferable for longs that are known to often be large or negative.
See Also:

  • Method Details

    • of

      public static VarLongCoder of()

    • encode

      public void encode(Long value, OutputStream outStream) throws IOException, CoderException
      Description copied from class: Coder
      Encodes the given value of type T onto the given output stream. Multiple elements can be encoded next to each other on the output stream, each coder should encode information to know how many bytes to read when decoding. A common approach is to prefix the encoding with the element's encoded length.
      Specified by:
      encode in class Coder<Long>
      Throws:
      IOException - if writing to the OutputStream fails for some reason
      CoderException - if the value could not be encoded for some reason

    • decode

      public Long decode(InputStream inStream) throws IOException, CoderException
      Description copied from class: Coder
      Decodes a value of type T from the given input stream in the given context. Returns the decoded value. Multiple elements can be encoded next to each other on the input stream, each coder should encode information to know how many bytes to read when decoding. A common approach is to prefix the encoding with the element's encoded length.
      Specified by:
      decode in class Coder<Long>
      Throws:
      IOException - if reading from the InputStream fails for some reason
      CoderException - if the value could not be decoded for some reason

    • getCoderArguments

      public List<? extends Coder<?>> getCoderArguments()
      Description copied from class: Coder
      If this is a Coder for a parameterized type, returns the list of Coders being used for each of the parameters in the same order they appear within the parameterized type's type signature. If this cannot be done, or this Coder does not encode/decode a parameterized type, returns the empty list.
      Specified by:
      getCoderArguments in class Coder<Long>

    • verifyDeterministic

      public void verifyDeterministic()
      Description copied from class: Coder
      Throw Coder.NonDeterministicException if the coding is not deterministic.

      In order for a Coder to be considered deterministic, the following must be true:

      • two values that compare as equal (via Object.equals() or Comparable.compareTo(), if supported) have the same encoding.
      • the Coder always produces a canonical encoding, which is the same for an instance of an object even if produced on different computers at different times.
      Specified by:
      verifyDeterministic in class Coder<Long>

    • consistentWithEquals

      public boolean consistentWithEquals()
      Returns true if this Coder is injective with respect to Object.equals(java.lang.Object).

      Whenever the encoded bytes of two values are equal, then the original values are equal according to Objects.equals(). Note that this is well-defined for null.

      This condition is most notably false for arrays. More generally, this condition is false whenever equals() compares object identity, rather than performing a semantic/structural comparison.

      By default, returns false.

      Overrides:
      consistentWithEquals in class Coder<Long>
      Returns:
      true. VarLongCoder is injective.

    • isRegisterByteSizeObserverCheap

      public boolean isRegisterByteSizeObserverCheap(Long value)
      Returns whether Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver) cheap enough to call for every element, that is, if this Coder can calculate the byte size of the element to be coded in roughly constant time (or lazily).

      Not intended to be called by user code, but instead by PipelineRunner implementations.

      By default, returns false. The default Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver) implementation invokes Coder.getEncodedElementByteSize(T) which requires re-encoding an element unless it is overridden. This is considered expensive.

      Overrides:
      isRegisterByteSizeObserverCheap in class Coder<Long>
      Returns:
      true. getEncodedElementByteSize(java.lang.Long) is cheap.

    • getEncodedTypeDescriptor

      public TypeDescriptor<Long> getEncodedTypeDescriptor()
      Description copied from class: Coder
      Returns the TypeDescriptor for the type encoded.
      Overrides:
      getEncodedTypeDescriptor in class Coder<Long>

    • getEncodedElementByteSize

      protected long getEncodedElementByteSize(Long value) throws Exception
      Description copied from class: Coder
      Returns the size in bytes of the encoded value using this coder.
      Overrides:
      getEncodedElementByteSize in class Coder<Long>
      Throws:
      Exception