Module org.refcodes.serial

Package org.refcodes.serial

Class StringSection

java.lang.Object

org.refcodes.serial.AbstractPayloadSection<String>

org.refcodes.serial.StringSection

All Implemented Interfaces:

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

public class StringSection
extends AbstractPayloadSection<String>
implements PayloadSection<String>, org.refcodes.mixin.EncodingAccessor<Charset>

The StringSection is an implementation of a Section carrying a String as payload. By default, if not otherwise specified, the TransmissionMetrics.DEFAULT_ENCODING encoding is used for encoding and decoding String instances.

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
StringSection()	Constructs an empty StringSection using the TransmissionMetrics.DEFAULT_ENCODING encoding for the payload.
StringSection(String aValue)	Constructs a StringSection with the given String payload being encoded with the TransmissionMetrics.DEFAULT_ENCODING.
StringSection(String aAlias, String aValue)	Constructs a StringSection with the given String payload being encoded with the TransmissionMetrics.DEFAULT_ENCODING.
StringSection(String aAlias, String aValue, Charset aCharset)	Constructs a StringSection with the given String payload being encoded with the given Charset.
StringSection(String aAlias, String aValue, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.
StringSection(String aValue, Charset aCharset)	Constructs a StringSection with the given String payload being encoded with the given Charset.
StringSection(String aValue, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.
StringSection(Charset aCharset)	Constructs a StringSection with a payload expected to be encoded with the given Charset.
StringSection(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.
Schema	toSchema()	Retrieves the Schema representing the Transmission.
Sequence	toSequence()	Provides the Sequence representation of this Transmission.
StringSection	withPayload(String 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.AliasAccessor

getAlias

Methods inherited from interface org.refcodes.mixin.PayloadAccessor

getPayload, getPayloadOr

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

setPayload

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 Detail

StringSection

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

StringSection

public StringSection(String 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 StringSection.

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

StringSection

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

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

StringSection

public StringSection()

Constructs an empty StringSection using the TransmissionMetrics.DEFAULT_ENCODING encoding for the payload.

StringSection

public StringSection(String aValue)

Constructs a StringSection with the given String payload being encoded with the TransmissionMetrics.DEFAULT_ENCODING.

Parameters:

aValue - The payload to be contained by this StringSection.

StringSection

public StringSection(Charset aCharset)

Constructs a StringSection with a payload expected to be encoded with the given Charset.

Parameters:

aCharset - The Charset to be used for encoding and decoding String instances.

StringSection

public StringSection(String aValue,
                     Charset aCharset)

Constructs a StringSection with the given String payload being encoded with the given Charset.

Parameters:

aValue - The payload to be contained by this StringSection.

aCharset - The Charset to be used for encoding the String.

StringSection

public StringSection(String aAlias,
                     String aValue)

Constructs a StringSection with the given String payload being encoded with the TransmissionMetrics.DEFAULT_ENCODING.

Parameters:

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

aValue - The payload to be contained by this StringSection.

StringSection

public StringSection(String aAlias,
                     String aValue,
                     Charset aCharset)

Constructs a StringSection with the given String payload being encoded with the given Charset.

Parameters:

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

aValue - The payload to be contained by this StringSection.

aCharset - The Charset to be used for encoding the String.

Method Detail

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 Schema toSchema()

Retrieves the Schema representing the Transmission. Retrieving a Schema 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 Transmission

Returns:

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

withPayload

public StringSection withPayload(String aValue)

Specified by:

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

getEncoding

public Charset getEncoding()

Specified by:

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