Module org.refcodes.serial

Package org.refcodes.serial

Class StringArraySection

java.lang.Object

org.refcodes.serial.StringArraySection

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[]>, org.refcodes.numerical.EndianessAccessor, LengthWidthAccessor, PayloadSection<String[]>, PayloadTransmission<String[]>, Section, Section.SectionMixin, Transmission, Transmission.TransmissionMixin

public class StringArraySection
extends Object
implements Section.SectionMixin, PayloadSection<String[]>, LengthWidthAccessor, org.refcodes.numerical.EndianessAccessor, org.refcodes.mixin.EncodingAccessor<Charset>

The StringArraySection is an implementation of a Section carrying a String array as payload. Each String is represented by a StringSection decorated by an AllocSectionDecoratorSegment.

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.numerical.EndianessAccessor

org.refcodes.numerical.EndianessAccessor.EndianessBuilder<B extends org.refcodes.numerical.EndianessAccessor.EndianessBuilder<B>>, org.refcodes.numerical.EndianessAccessor.EndianessMutator, org.refcodes.numerical.EndianessAccessor.EndianessProperty

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.serial.LengthWidthAccessor

LengthWidthAccessor.LengthWidthBuilder<B extends LengthWidthAccessor.LengthWidthBuilder<B>>, LengthWidthAccessor.LengthWidthMutator, LengthWidthAccessor.LengthWidthProperty

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

Constructor Summary

Constructors

Constructor	Description
StringArraySection()	Constructs an empty StringArraySection using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, the TransmissionMetrics.DEFAULT_ENDIANESS as well as the TransmissionMetrics.DEFAULT_ENCODING.
StringArraySection(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset, String... aPayload)	Constructs a StringArraySection using containing the provided StringSection elements and using the provided Segment class for creating Segment instances.
StringArraySection(String aAlias)	Constructs an empty StringArraySection using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, the TransmissionMetrics.DEFAULT_ENDIANESS as well as the TransmissionMetrics.DEFAULT_ENCODING.
StringArraySection(String... aPayload)	Constructs a StringArraySection containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, the TransmissionMetrics.DEFAULT_ENDIANESS as well as the TransmissionMetrics.DEFAULT_ENCODING.
StringArraySection(String aAlias, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset, String... aPayload)	Constructs a StringArraySection using containing the provided StringSection elements and using the provided Segment class for creating Segment instances.
StringArraySection(String aAlias, String[] aPayload)	Constructs a StringArraySection containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, the TransmissionMetrics.DEFAULT_ENDIANESS as well as the TransmissionMetrics.DEFAULT_ENCODING.
StringArraySection(String aAlias, Charset aCharset, String... aPayload)	Constructs a StringArraySection containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, as well as the TransmissionMetrics.DEFAULT_ENDIANESS.
StringArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.
StringArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, String... aValue)	Constructs an according instance from the given configuration.
StringArraySection(Charset aCharset, String... aPayload)	Constructs a StringArraySection containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, as well as the TransmissionMetrics.DEFAULT_ENDIANESS.
StringArraySection(TransmissionMetrics aTransmissionMetrics)	Constructs an according instance from the given configuration.
StringArraySection(TransmissionMetrics aTransmissionMetrics, String... aValue)	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.
String	getAlias()
Charset	getEncoding()
org.refcodes.numerical.Endianess	getEndianess()
int	getLength()	Determines the overall length of this Transmission.
int	getLengthWidth()	Retrieves the length width (in bytes) from the length width (in bytes) property.
String[]	getPayload()
void	receiveFrom(InputStream aInputStream, int aLength, OutputStream aReturnStream)	Default implementation harnessing the Section.fromTransmission(Sequence, int) method.
void	setPayload(String[] aValue)
Schema	toSchema()	Retrieves the Schema representing the Transmission.
Sequence	toSequence()	Provides the Sequence representation of this Transmission.
org.refcodes.struct.SimpleTypeMap	toSimpleTypeMap()	Returns the SimpleTypeMap representation of this Transmission.
StringArraySection	withPayload(String[] aValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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.Transmission

transmitTo, transmitTo

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

transmitTo

Constructor Detail

StringArraySection

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

StringArraySection

public StringArraySection(TransmissionMetrics aTransmissionMetrics,
                          String... aValue)

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.

aValue - The payload to be contained by the StringArraySection.

StringArraySection

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

StringArraySection

public StringArraySection(String aAlias,
                          TransmissionMetrics aTransmissionMetrics,
                          String... aValue)

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.

aValue - The payload to be contained by the StringArraySection.

StringArraySection

public StringArraySection()

Constructs an empty StringArraySection using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, the TransmissionMetrics.DEFAULT_ENDIANESS as well as the TransmissionMetrics.DEFAULT_ENCODING.

StringArraySection

public StringArraySection(String... aPayload)

Constructs a StringArraySection containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, the TransmissionMetrics.DEFAULT_ENDIANESS as well as the TransmissionMetrics.DEFAULT_ENCODING.

Parameters:

aPayload - The String elements being contained in this instance.

StringArraySection

public StringArraySection(Charset aCharset,
                          String... aPayload)

Constructs a StringArraySection containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, as well as the TransmissionMetrics.DEFAULT_ENDIANESS.

Parameters:

aCharset - The Charset to use when encoding or decoding the String instances.

aPayload - The String elements being contained in this instance.

StringArraySection

public StringArraySection(int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess,
                          Charset aCharset,
                          String... aPayload)

Constructs a StringArraySection using containing the provided StringSection elements and using the provided Segment class for creating Segment instances.

Parameters:

aLengthWidth - The width (in bytes) to be used for size values.

aEndianess - The Endianess to be used for size values.

aCharset - The Charset to use when encoding or decoding the String instances.

aPayload - The String elements being contained in this instance.

StringArraySection

public StringArraySection(String aAlias)

Constructs an empty StringArraySection using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, the TransmissionMetrics.DEFAULT_ENDIANESS as well as the TransmissionMetrics.DEFAULT_ENCODING.

Parameters:

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

StringArraySection

public StringArraySection(String aAlias,
                          String[] aPayload)

Constructs a StringArraySection containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, the TransmissionMetrics.DEFAULT_ENDIANESS as well as the TransmissionMetrics.DEFAULT_ENCODING.

Parameters:

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

aPayload - The String elements being contained in this instance.

StringArraySection

public StringArraySection(String aAlias,
                          Charset aCharset,
                          String... aPayload)

Constructs a StringArraySection containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, as well as the TransmissionMetrics.DEFAULT_ENDIANESS.

Parameters:

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

aCharset - The Charset to use when encoding or decoding the String instances.

aPayload - The String elements being contained in this instance.

StringArraySection

public StringArraySection(String aAlias,
                          int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess,
                          Charset aCharset,
                          String... aPayload)

Constructs a StringArraySection using containing the provided StringSection elements and using the provided Segment class for creating Segment instances.

Parameters:

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

aLengthWidth - The width (in bytes) to be used for size values.

aEndianess - The Endianess to be used for size values.

aCharset - The Charset to use when encoding or decoding the String instances.

aPayload - The String elements being contained in this instance.

Method Detail

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.

receiveFrom

public void receiveFrom(InputStream aInputStream,
                        int aLength,
                        OutputStream aReturnStream)
                 throws IOException,
                        TransmissionException

Default implementation harnessing the Section.fromTransmission(Sequence, int) method. (Re-)initializes this instance by receiving the according Sequence from the given InputStream. Implementations providing error correction methods use the provided feedback OutputStream to do some sort of "stop-and-wait ARQ" or apply similar methods to ensure correctness of the received data.

Specified by:

receiveFrom in interface Section

Specified by:

receiveFrom in interface Section.SectionMixin

Parameters:

aInputStream - The InputStream from which to read the instance's (re-)initialization Sequence from.

aLength - The length of data assigned by the byte array.

aReturnStream - An OutputStream being the return channel to handle "stop-and-wait ARQ" or the like in case of a bidirectional connection. Can be null in case we have a unidirectional connection.

Throws:

IOException - thrown in case reading data from the InputStream caused problems.

TransmissionException - thrown in case a given InputStream bytes cannot be processed.

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.

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.

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

getPayload

public String[] getPayload()

Specified by:

getPayload in interface org.refcodes.mixin.PayloadAccessor<String[]>

setPayload

public void setPayload(String[] aValue)

Specified by:

setPayload in interface org.refcodes.mixin.PayloadAccessor.PayloadMutator<String[]>

withPayload

public StringArraySection withPayload(String[] aValue)

Specified by:

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

getLengthWidth

public int getLengthWidth()

Retrieves the length width (in bytes) from the length width (in bytes) property.

Specified by:

getLengthWidth in interface LengthWidthAccessor

Returns:

The length width (in bytes) stored by the length width (in bytes) property.

getEndianess

public org.refcodes.numerical.Endianess getEndianess()

Specified by:

getEndianess in interface org.refcodes.numerical.EndianessAccessor

getEncoding

public Charset getEncoding()

Specified by:

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

getAlias

public String getAlias()

Specified by:

getAlias in interface org.refcodes.mixin.AliasAccessor

toSimpleTypeMap

public org.refcodes.struct.SimpleTypeMap toSimpleTypeMap()

Returns the SimpleTypeMap representation of this Transmission. In case this Transmission has Transmission children, then the children are queried as well and contained in the resulting SimpleTypeMap. The aliases of the according Transmission instances represent the resulting path to a Transmission's final simple type.

Specified by:

toSimpleTypeMap in interface Transmission

Returns:

The SimpleTypeMap representing this Transmission and (if any) its children, with the according aliases forming the paths to the Transmission's values.