Module org.refcodes.serial
Package org.refcodes.serial

Class ShortSegment

java.lang.Object
org.refcodes.serial.AbstractPayloadSegment<Short>
org.refcodes.serial.ShortSegment
All Implemented Interfaces:
Serializable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.PayloadAccessor<Short>, org.refcodes.mixin.PayloadAccessor.PayloadBuilder<Short,PayloadTransmission<Short>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<Short>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<Short>, org.refcodes.mixin.Resetable, org.refcodes.schema.Schemable, PayloadSegment<Short>, PayloadTransmission<Short>, Segment, Segment.SegmentMixin, Transmission, Transmission.TransmissionMixin
public class ShortSegment extends AbstractPayloadSegment<Short> implements Segment
The ShortSegment is an implementation of a Segment carrying in short value as payload.
See Also:

  • Field Details

  • Constructor Details

    • ShortSegment

      public ShortSegment(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

    • ShortSegment

      public ShortSegment(Short aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

    • ShortSegment

      public ShortSegment(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

    • ShortSegment

      public ShortSegment(String aAlias, Short aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

    • ShortSegment

      public ShortSegment()
      Constructs an empty ShortSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the ShortSegment's value.

    • ShortSegment

      public ShortSegment(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty ShortSegment with the given Endianess endian representation of the ShortSegment's value.
      Parameters:
      aEndianess - The Endianess to be used for the payload values.

    • ShortSegment

      public ShortSegment(Short aValue)
      Constructs a ShortSegment with the given short payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the ShortSegment's value.
      Parameters:
      aValue - The value (payload) to be contained by the ShortSegment.

    • ShortSegment

      public ShortSegment(Short aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a ShortSegment with the given short payload and the given Endianess for the representation of the Segment's value.
      Parameters:
      aValue - The value (payload) to be contained by the ShortSegment.
      aEndianess - The Endianess to be used for the payload values.

    • ShortSegment

      public ShortSegment(String aAlias)
      Constructs an empty ShortSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the ShortSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.

    • ShortSegment

      public ShortSegment(String aAlias, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty ShortSegment with the given Endianess endian representation of the ShortSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for the payload values.

    • ShortSegment

      public ShortSegment(String aAlias, Short aValue)
      Constructs a ShortSegment with the given short payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the ShortSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the ShortSegment.

    • ShortSegment

      public ShortSegment(String aAlias, Short aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a ShortSegment with the given short payload and the given Endianess for the representation of the Segment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the ShortSegment.
      aEndianess - The Endianess to be used for the payload values.

  • Method Details

    • toSequence

      public Sequence toSequence()
      Provides the Sequence representation of this Transmission. In case of nested Transmission instances, all Sequence representations from all sub-segments are accumulated to the result as well. Caution, the Transmission (or its nested Transmission instances) may be backed by the returned Sequence.
      Specified by:
      toSequence in interface Transmission
      Returns:
      The according instance's Sequence.

    • fromTransmission

      public int fromTransmission(Sequence aSequence, int aOffset) throws TransmissionException
      (Re-)initializes this instance with the the given Sequence data.
      Specified by:
      fromTransmission in interface Segment
      Parameters:
      aSequence - The Sequence data from which to (re-)initialize this instance.
      aOffset - The offset where to start processing the provided Sequence.
      Returns:
      The index after the last offset into the given Sequence processed by this method.
      Throws:
      TransmissionException - thrown in case a given Sequence cannot be processed.

    • getLength

      public int getLength()
      Determines the overall length of this Transmission. In case of nested Transmission instances, all length values from all sub-segments are accumulated to the result as well.
      Specified by:
      getLength in interface org.refcodes.mixin.LengthAccessor
      Specified by:
      getLength in interface Transmission
      Returns:
      The (overall) length of the Transmission (including any sub-segments).

    • reset

      public void reset()
      Resets any dynamic data (e.g. values such as payloads or checksums) and must not(!) reset any configurations or settings required to produce the dynamic data (e.g. the TransmissionMetrics).
      Specified by:
      reset in interface org.refcodes.mixin.Resetable
      Specified by:
      reset in interface Transmission
      Overrides:
      reset in class AbstractPayloadSegment<Short>

    • toSchema

      public SerialSchema toSchema()
      Specified by:
      toSchema in interface org.refcodes.schema.Schemable
      Specified by:
      toSchema in interface Transmission

    • withPayload

      public ShortSegment withPayload(Short aValue)
      Specified by:
      withPayload in interface org.refcodes.mixin.PayloadAccessor.PayloadBuilder<Short,PayloadTransmission<Short>>