Class NumberSegment

java.lang.Object

org.refcodes.serial.AbstractPayloadSegment<Long>

org.refcodes.serial.NumberSegment

All Implemented Interfaces:

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

Direct Known Subclasses:

SequenceNumberSegment

public class NumberSegment
extends AbstractPayloadSegment<Long>
implements Segment, ValueAccessor.ValueProperty<Long>, ValueAccessor.ValueBuilder<Long, NumberSegment>

The NumberSegment is an implementation of a Segment carrying an integer value with a configurable width (in bytes) as payload.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface AliasAccessor

AliasAccessor.AliasBuilder<B>, AliasAccessor.AliasMutator, AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface LengthAccessor

LengthAccessor.LengthBuilder<B>, LengthAccessor.LengthMutator, LengthAccessor.LengthProperty

Nested classes/interfaces inherited from interface PayloadAccessor

PayloadAccessor.PayloadBuilder<P,B>, PayloadAccessor.PayloadMutator<P>, PayloadAccessor.PayloadProperty<P>

Nested classes/interfaces inherited from interface Segment

Segment.SegmentMixin

Nested classes/interfaces inherited from interface Transmission

Transmission.TransmissionMixin

Nested classes/interfaces inherited from interface ValueAccessor

ValueAccessor.ValueBuilder<V,B>, ValueAccessor.ValueMutator<V>, ValueAccessor.ValueProperty<V>

Field Summary

Fields inherited from class AbstractPayloadSegment

_alias, _payload

Constructor Summary

Constructors

Constructor	Description
NumberSegment(int aNumberWidth)	Constructs an empty NumberSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the NumberSegment's value.
NumberSegment(int aNumberWidth, Long aValue)	Constructs a NumberSegment with the given long payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the NumberSegment's value.
NumberSegment(int aNumberWidth, Long aValue, Endianess aEndianess)	Constructs a NumberSegment with the given long payload and the given Endianess for the representation of the NumberSegment's value (payload).
NumberSegment(int aNumberWidth, Long aValue, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.
NumberSegment(int aNumberWidth, Endianess aEndianess)	Constructs an empty NumberSegment with the given Endianess.
NumberSegment(int aNumberWidth, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.
NumberSegment(String aAlias, int aNumberWidth)	Constructs an empty NumberSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the NumberSegment's value.
NumberSegment(String aAlias, int aNumberWidth, Long aValue)	Constructs a NumberSegment with the given long payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the NumberSegment's value.
NumberSegment(String aAlias, int aNumberWidth, Long aValue, Endianess aEndianess)	Constructs a NumberSegment with the given long payload and the given Endianess for the representation of the NumberSegment's value (payload).
NumberSegment(String aAlias, int aNumberWidth, Endianess aEndianess)	Constructs an empty NumberSegment with the given Endianess.
NumberSegment(String aAlias, int aNumberWidth, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.

Method Summary

Modifier and Type	Method	Description
int	fromTransmission(Sequence aSequence, int aOffset)	(Re-)initializes this instance with the the given Sequence data.
int	getLength()	Determines the overall length of this Transmission.
Long	getValue()
void	reset()	Resets any dynamic data (e.g. values such as payloads or checksums) and must not(!)
void	setValue(Long aValue)
Schema	toSchema()
Sequence	toSequence()	Provides the Sequence representation of this Transmission.
NumberSegment	withPayload(Long aValue)
NumberSegment	withValue(Long aValue)

Methods inherited from class AbstractPayloadSegment

equals, getAlias, getPayload, hashCode, setPayload, toSimpleTypeTable, toString

Methods inherited from class Object

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

Methods inherited from interface PayloadAccessor

getPayloadOr

Methods inherited from interface PayloadAccessor.PayloadProperty

letPayload

Methods inherited from interface Schemable

toSchema

Methods inherited from interface Segment

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface Segment.SegmentMixin

receiveFrom

Methods inherited from interface Transmission

toSimpleTypeTable, transmitTo, transmitTo

Methods inherited from interface Transmission.TransmissionMixin

transmitTo

Methods inherited from interface ValueAccessor

getValueOr, hasValue

Methods inherited from interface ValueAccessor.ValueProperty

letValue

Constructor Details

NumberSegment

public NumberSegment(int aNumberWidth,
 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:

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

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

NumberSegment

public NumberSegment(int aNumberWidth,
 Long 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:

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

aValue - The payload to be contained by the DoubleArraySection.

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

NumberSegment

public NumberSegment(String aAlias,
 int aNumberWidth,
 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.

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

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

NumberSegment

public NumberSegment(int aNumberWidth)

Constructs an empty NumberSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the NumberSegment's value.

Parameters:

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

NumberSegment

public NumberSegment(int aNumberWidth,
 Endianess aEndianess)

Constructs an empty NumberSegment with the given Endianess.

Parameters:

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

aEndianess - The Endianess to be used for payload values.

NumberSegment

public NumberSegment(int aNumberWidth,
 Long aValue)

Constructs a NumberSegment with the given long payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the NumberSegment's value.

Parameters:

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

aValue - The payload to be contained by the NumberSegment.

NumberSegment

public NumberSegment(int aNumberWidth,
 Long aValue,
 Endianess aEndianess)

Constructs a NumberSegment with the given long payload and the given Endianess for the representation of the NumberSegment's value (payload).

Parameters:

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

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

aEndianess - The Endianess to be used for payload values.

NumberSegment

public NumberSegment(String aAlias,
 int aNumberWidth)

Constructs an empty NumberSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the NumberSegment's value.

Parameters:

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

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

NumberSegment

public NumberSegment(String aAlias,
 int aNumberWidth,
 Endianess aEndianess)

Constructs an empty NumberSegment with the given Endianess.

Parameters:

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

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

aEndianess - The Endianess to be used for payload values.

NumberSegment

public NumberSegment(String aAlias,
 int aNumberWidth,
 Long aValue)

Constructs a NumberSegment with the given long payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the NumberSegment's value.

Parameters:

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

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

aValue - The payload to be contained by the NumberSegment.

NumberSegment

public NumberSegment(String aAlias,
 int aNumberWidth,
 Long aValue,
 Endianess aEndianess)

Constructs a NumberSegment with the given long payload and the given Endianess for the representation of the NumberSegment's value (payload).

Parameters:

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

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

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

aEndianess - The Endianess to be used for 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 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 Resetable

Specified by:

reset in interface Transmission

Overrides:

reset in class AbstractPayloadSegment<Long>

toSchema

public Schema toSchema()

Specified by:

toSchema in interface Schemable<DiagnosticOptions>

withPayload

public NumberSegment withPayload(Long aValue)

Specified by:

withPayload in interface PayloadAccessor.PayloadBuilder<Long, PayloadTransmission<Long>>

getValue

public Long getValue()

Specified by:

getValue in interface ValueAccessor<Long>

setValue

public void setValue(Long aValue)

Specified by:

setValue in interface ValueAccessor.ValueMutator<Long>

withValue

public NumberSegment withValue(Long aValue)

Specified by:

withValue in interface ValueAccessor.ValueBuilder<Long, NumberSegment>