Module org.refcodes.serial

Package org.refcodes.serial

Class SequenceNumberSegment

java.lang.Object

org.refcodes.serial.AbstractPayloadSegment<Long>

org.refcodes.serial.NumberSegment

org.refcodes.serial.SequenceNumberSegment

All Implemented Interfaces:

Serializable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.PayloadAccessor<Long>, org.refcodes.mixin.PayloadAccessor.PayloadBuilder<Long,PayloadTransmission<Long>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<Long>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<Long>, org.refcodes.mixin.Resetable, org.refcodes.mixin.ValueAccessor<Long>, org.refcodes.mixin.ValueAccessor.ValueBuilder<Long,NumberSegment>, org.refcodes.mixin.ValueAccessor.ValueMutator<Long>, org.refcodes.mixin.ValueAccessor.ValueProperty<Long>, org.refcodes.schema.Schemable, PayloadSegment<Long>, PayloadTransmission<Long>, Segment, Segment.SegmentMixin, Transmission, Transmission.TransmissionMixin

public class SequenceNumberSegment
extends NumberSegment

Convenience class for the NumberSegment using TransmissionMetrics sequence number related properties to configure the SequenceNumberSegment (being an accordingly configured NumberSegment).

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor

org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.LengthAccessor

org.refcodes.mixin.LengthAccessor.LengthBuilder<B extends org.refcodes.mixin.LengthAccessor.LengthBuilder<B>>, org.refcodes.mixin.LengthAccessor.LengthMutator, org.refcodes.mixin.LengthAccessor.LengthProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.PayloadAccessor

org.refcodes.mixin.PayloadAccessor.PayloadBuilder<P extends Object,B extends org.refcodes.mixin.PayloadAccessor.PayloadBuilder<P,B>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<P extends Object>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<P extends Object>

Nested classes/interfaces inherited from interface org.refcodes.serial.Segment

Segment.SegmentMixin

Nested classes/interfaces inherited from interface org.refcodes.serial.Transmission

Transmission.TransmissionMixin

Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor

org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends Object,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends Object>

Field Summary

Fields inherited from class org.refcodes.serial.NumberSegment

ENDIANESS

Fields inherited from class org.refcodes.serial.AbstractPayloadSegment

_alias, _payload

Constructor Summary

Constructors

Constructor	Description
SequenceNumberSegment(int aSequenceNumberWidth, Long aSequenceNumberInitValue, org.refcodes.numerical.Endianess aEndianess)	Constructs a SequenceNumberSegment with the given TransmissionMetrics.
SequenceNumberSegment(int aSequenceNumberWidth, org.refcodes.numerical.Endianess aEndianess)	Constructs a SequenceNumberSegment with the given TransmissionMetrics.
SequenceNumberSegment(Long aSequenceNumberInitValue, TransmissionMetrics aTransmissionMetrics)	Constructs a SequenceNumberSegment with the given TransmissionMetrics.
SequenceNumberSegment(String aAlias, int aSequenceNumberWidth, Long aSequenceNumberInitValue, org.refcodes.numerical.Endianess aEndianess)	Constructs a SequenceNumberSegment with the given TransmissionMetrics.
SequenceNumberSegment(String aAlias, int aSequenceNumberWidth, org.refcodes.numerical.Endianess aEndianess)	Constructs a SequenceNumberSegment with the given TransmissionMetrics.
SequenceNumberSegment(String aAlias, Long aSequenceNumberInitValue, TransmissionMetrics aTransmissionMetrics)	Constructs a SequenceNumberSegment with the given TransmissionMetrics.
SequenceNumberSegment(String aAlias, TransmissionMetrics aTransmissionMetrics)	Constructs a SequenceNumberSegment with the given TransmissionMetrics.
SequenceNumberSegment(TransmissionMetrics aTransmissionMetrics)	Constructs a SequenceNumberSegment with the given TransmissionMetrics.

Method Summary

Methods inherited from class org.refcodes.serial.NumberSegment

fromTransmission, getLength, getValue, reset, setValue, toSchema, toSequence, withPayload, withValue

Methods inherited from class org.refcodes.serial.AbstractPayloadSegment

equals, getAlias, getPayload, hashCode, setPayload, toSimpleTypeMap, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.PayloadAccessor

getPayloadOr

Methods inherited from interface org.refcodes.mixin.PayloadAccessor.PayloadProperty

letPayload

Methods inherited from interface org.refcodes.serial.Segment

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Segment.SegmentMixin

receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

toSimpleTypeMap, transmitTo, transmitTo

Methods inherited from interface org.refcodes.serial.Transmission.TransmissionMixin

transmitTo

Methods inherited from interface org.refcodes.mixin.ValueAccessor

getValueOr

Methods inherited from interface org.refcodes.mixin.ValueAccessor.ValueProperty

letValue

Constructor Details

SequenceNumberSegment

public SequenceNumberSegment(TransmissionMetrics aTransmissionMetrics)

Constructs a SequenceNumberSegment with the given TransmissionMetrics. Only those properties of the TransmissionMetrics are considered which are also supported by the other constructors.

Parameters:

aTransmissionMetrics - The TransmissionMetrics used to configure the SequenceNumberSegment.

SequenceNumberSegment

public SequenceNumberSegment(Long aSequenceNumberInitValue,
 TransmissionMetrics aTransmissionMetrics)

Constructs a SequenceNumberSegment with the given TransmissionMetrics. Only those properties of the TransmissionMetrics are considered which are also supported by the other constructors.

Parameters:

aSequenceNumberInitValue - The value (payload) to be contained by the SequenceNumberSegment.

aTransmissionMetrics - The TransmissionMetrics used to configure the SequenceNumberSegment.

SequenceNumberSegment

public SequenceNumberSegment(String aAlias,
 TransmissionMetrics aTransmissionMetrics)

Constructs a SequenceNumberSegment with the given TransmissionMetrics. Only those properties of the TransmissionMetrics are considered which are also supported by the other constructors.

Parameters:

aAlias - The alias which identifies the content of this segment.

aTransmissionMetrics - The TransmissionMetrics used to configure the SequenceNumberSegment.

SequenceNumberSegment

public SequenceNumberSegment(String aAlias,
 Long aSequenceNumberInitValue,
 TransmissionMetrics aTransmissionMetrics)

Constructs a SequenceNumberSegment with the given TransmissionMetrics. Only those properties of the TransmissionMetrics are considered which are also supported by the other constructors.

Parameters:

aAlias - The alias which identifies the content of this segment.

aSequenceNumberInitValue - The value (payload) to be contained by the SequenceNumberSegment.

aTransmissionMetrics - The TransmissionMetrics used to configure the SequenceNumberSegment.

SequenceNumberSegment

public SequenceNumberSegment(int aSequenceNumberWidth,
 org.refcodes.numerical.Endianess aEndianess)

Constructs a SequenceNumberSegment with the given TransmissionMetrics. Only those properties of the TransmissionMetrics are considered which are also supported by the other constructors.

Parameters:

aSequenceNumberWidth - The number of bytes to be occupied by the number.

aEndianess - The Endianess to be used for payload values.

SequenceNumberSegment

public SequenceNumberSegment(int aSequenceNumberWidth,
 Long aSequenceNumberInitValue,
 org.refcodes.numerical.Endianess aEndianess)

Constructs a SequenceNumberSegment with the given TransmissionMetrics. Only those properties of the TransmissionMetrics are considered which are also supported by the other constructors.

Parameters:

aSequenceNumberWidth - The number of bytes to be occupied by the number.

aSequenceNumberInitValue - The value (payload) to be contained by the NumberSegment.

aEndianess - The Endianess to be used for payload values.

SequenceNumberSegment

public SequenceNumberSegment(String aAlias,
 int aSequenceNumberWidth,
 org.refcodes.numerical.Endianess aEndianess)

Constructs a SequenceNumberSegment with the given TransmissionMetrics. Only those properties of the TransmissionMetrics are considered which are also supported by the other constructors.

Parameters:

aAlias - The alias which identifies the content of this segment.

aSequenceNumberWidth - The number of bytes to be occupied by the number.

aEndianess - The Endianess to be used for payload values.

SequenceNumberSegment

public SequenceNumberSegment(String aAlias,
 int aSequenceNumberWidth,
 Long aSequenceNumberInitValue,
 org.refcodes.numerical.Endianess aEndianess)

Constructs a SequenceNumberSegment with the given TransmissionMetrics. Only those properties of the TransmissionMetrics are considered which are also supported by the other constructors.

Parameters:

aAlias - The alias which identifies the content of this segment.

aSequenceNumberWidth - The number of bytes to be occupied by the number.

aSequenceNumberInitValue - The value (payload) to be contained by the NumberSegment.

aEndianess - The Endianess to be used for payload values.