Module org.refcodes.serial

Package org.refcodes.serial

Class CharSection

java.lang.Object

org.refcodes.serial.AbstractPayloadSection<Character>

org.refcodes.serial.CharSection

All Implemented Interfaces:

Serializable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.EncodingAccessor<Charset>, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.PayloadAccessor<Character>, org.refcodes.mixin.PayloadAccessor.PayloadBuilder<Character,PayloadTransmission<Character>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<Character>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<Character>, org.refcodes.mixin.Schemable<SerialSchema>, PayloadSection<Character>, PayloadTransmission<Character>, Section, Section.SectionMixin, Transmission, Transmission.TransmissionMixin

public class CharSection
extends AbstractPayloadSection<Character>
implements Section, org.refcodes.mixin.EncodingAccessor<Charset>

The CharSection is an implementation of a Section carrying a char value as payload.

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.EncodingAccessor

org.refcodes.mixin.EncodingAccessor.EncodingBuilder<E extends Object,B extends org.refcodes.mixin.EncodingAccessor.EncodingBuilder<E,B>>, org.refcodes.mixin.EncodingAccessor.EncodingMutator<E extends Object>, org.refcodes.mixin.EncodingAccessor.EncodingProperty<E extends Object>

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.Section

Section.SectionMixin

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

Transmission.TransmissionMixin

Field Summary

Fields inherited from class org.refcodes.serial.AbstractPayloadSection

_alias, _payload

Constructor Summary

Constructors

Constructor	Description
CharSection()	Constructs an empty CharSection.
CharSection(char aValue, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.
CharSection(Character aPayload)	Constructs a CharSection with the given char payload.
CharSection(Character aPayload, Charset aCharset)	Constructs a CharSection with the given char payload and the given Charset.
CharSection(Character aValue, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.
CharSection(String aAlias)	Constructs an empty CharSection.
CharSection(String aAlias, char aValue, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.
CharSection(String aAlias, Character aPayload)	Constructs a CharSection with the given char payload.
CharSection(String aAlias, Character aPayload, Charset aCharset)	Constructs a CharSection with the given char payload and the given Charset.
CharSection(String aAlias, Character aValue, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.
CharSection(String aAlias, Charset aCharset)	Constructs an empty CharSection with the given Charset.
CharSection(String aAlias, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.
CharSection(Charset aCharset)	Constructs an empty CharSection with the given Charset.
CharSection(TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.

Method Summary

Modifier and Type	Method	Description
void	fromTransmission(Sequence aSequence, int aOffset, int aLength)	(Re-)initializes this instance with the the given Sequence data.
Charset	getEncoding()
int	getLength()	Determines the overall length of this Transmission.
SerialSchema	toSchema()	Retrieves the SerialSchema representing the Transmission.
Sequence	toSequence()	Provides the Sequence representation of this Transmission.
CharSection	withPayload(Character aValue)

Methods inherited from class org.refcodes.serial.AbstractPayloadSection

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.Section

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Section.SectionMixin

receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

toSimpleTypeMap, transmitTo, transmitTo

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

transmitTo

Constructor Details

CharSection

public CharSection(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.

CharSection

public CharSection(char 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 CharSection.

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

CharSection

public CharSection(Character 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 CharSection.

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

CharSection

public CharSection(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.

CharSection

public CharSection(String aAlias,
 char 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 CharSection.

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

CharSection

public CharSection(String aAlias,
 Character 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 CharSection.

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

CharSection

public CharSection()

Constructs an empty CharSection.

CharSection

public CharSection(Charset aCharset)

Constructs an empty CharSection with the given Charset.

Parameters:

aCharset - The charset to be used for encoding.

CharSection

public CharSection(Character aPayload)

Constructs a CharSection with the given char payload.

Parameters:

aPayload - The payload to be contained by the Section.

CharSection

public CharSection(Character aPayload,
 Charset aCharset)

Constructs a CharSection with the given char payload and the given Charset.

Parameters:

aPayload - The payload to be contained by the Section.

aCharset - The charset to be used for encoding.

CharSection

public CharSection(String aAlias)

Constructs an empty CharSection.

Parameters:

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

CharSection

public CharSection(String aAlias,
 Charset aCharset)

Constructs an empty CharSection with the given Charset.

Parameters:

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

aCharset - The charset to be used for encoding.

CharSection

public CharSection(String aAlias,
 Character aPayload)

Constructs a CharSection with the given char payload.

Parameters:

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

aPayload - The payload to be contained by the Section.

CharSection

public CharSection(String aAlias,
 Character aPayload,
 Charset aCharset)

Constructs a CharSection with the given char payload and the given Charset.

Parameters:

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

aPayload - The payload to be contained by the Section.

aCharset - The charset to be used for encoding.

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 void fromTransmission(Sequence aSequence,
 int aOffset,
 int aLength)
                      throws TransmissionException

(Re-)initializes this instance with the the given Sequence data.

Specified by:

fromTransmission in interface Section

Parameters:

aSequence - The Sequence data from which to (re-)initialize this instance.

aOffset - The offset where to start processing the provided Sequence.

aLength - The length of data assigned by the Sequence.

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).

toSchema

public SerialSchema toSchema()

Retrieves the SerialSchema representing the Transmission. Retrieving a SerialSchema is useful when analyzing and debugging data structures such as a AllocSectionDecoratorSegment instance to help document, learn and verify on the structure (as well as the content) of that very AllocSectionDecoratorSegment.

Specified by:

toSchema in interface org.refcodes.mixin.Schemable<SerialSchema>

Specified by:

toSchema in interface Transmission

Returns:

The SerialSchema representation of the implementing type for debugging and verification (or documentation) purposes.

withPayload

public CharSection withPayload(Character aValue)

Specified by:

withPayload in interface org.refcodes.mixin.PayloadAccessor.PayloadBuilder<Character,PayloadTransmission<Character>>

getEncoding

public Charset getEncoding()

Specified by:

getEncoding in interface org.refcodes.mixin.EncodingAccessor<Charset>