Class SegmentArraySection<ARRAY extends Segment>

java.lang.Object

org.refcodes.serial.AbstractArrayTransmission<ARRAY>

org.refcodes.serial.SegmentArraySection<ARRAY>

Type Parameters:

ARRAY - The type of the array elements to be contained in this instance.

All Implemented Interfaces:

Serializable, AliasAccessor, ArrayAccessor<ARRAY[]>, ArrayAccessor.ArrayBuilder<ARRAY[], ArrayTransmission<ARRAY>>, ArrayAccessor.ArrayMutator<ARRAY[]>, ArrayAccessor.ArrayProperty<ARRAY[]>, LengthAccessor, Resetable, Diagnosable, Schemable<DiagnosticOptions>, ArraySection<ARRAY>, ArrayTransmission<ARRAY>, Section, Section.SectionMixin, Transmission, Transmission.TransmissionMixin

public class SegmentArraySection<ARRAY extends Segment>
extends AbstractArrayTransmission<ARRAY>
implements Section, ArraySection<ARRAY>

A SegmentArraySection is a Segment consisting of Segment elements with each element of presumably different lengths ( in contrast to the FixedSegmentArraySection).

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 ArrayAccessor

ArrayAccessor.ArrayBuilder<T,B>, ArrayAccessor.ArrayMutator<T>, ArrayAccessor.ArrayProperty<T>

Nested classes/interfaces inherited from interface LengthAccessor

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

Nested classes/interfaces inherited from interface Section

Section.SectionMixin

Nested classes/interfaces inherited from interface Transmission

Transmission.TransmissionMixin

Field Summary

Fields inherited from class AbstractArrayTransmission

_alias, _array, _sequenceableFactory

Constructor Summary

Constructors

Constructor	Description
SegmentArraySection(ARRAY... aSegments)	Instantiates the class SegmentArraySection.
SegmentArraySection(Class<ARRAY> aSegmentClass)	Instantiates the class SegmentArraySection.
SegmentArraySection(String aAlias, ARRAY... aSegments)	Instantiates the class SegmentArraySection.
SegmentArraySection(String aAlias, Class<ARRAY> aSegmentClass)	Instantiates the class SegmentArraySection.
SegmentArraySection(String aAlias, Collection<ARRAY> aSegments)	Instantiates the class SegmentArraySection.
SegmentArraySection(String aAlias, TypeFactory<ARRAY> aSegmentFactory)	Instantiates the class SegmentArraySection.
SegmentArraySection(String aAlias, TypeFactory<ARRAY> aSegmentFactory, ARRAY... aSegments)	Instantiates the class SegmentArraySection.
SegmentArraySection(String aAlias, TypeFactory<ARRAY> aSegmentFactory, Collection<ARRAY> aSegments)	Instantiates the class SegmentArraySection.
SegmentArraySection(Collection<ARRAY> aSegments)	Instantiates the class SegmentArraySection.
SegmentArraySection(TypeFactory<ARRAY> aSegmentFactory)	Instantiates the class SegmentArraySection.
SegmentArraySection(TypeFactory<ARRAY> aSegmentFactory, ARRAY... aSegments)	Instantiates the class SegmentArraySection.
SegmentArraySection(TypeFactory<ARRAY> aSegmentFactory, Collection<ARRAY> aSegments)	Instantiates the class SegmentArraySection.

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.
SegmentArraySection<ARRAY>	withArray(ARRAY[] aValue)

Methods inherited from class AbstractArrayTransmission

getAlias, getArray, getLength, reset, setArray, toSchema, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface AliasAccessor

getAlias

Methods inherited from interface ArrayAccessor

getArray

Methods inherited from interface ArrayAccessor.ArrayMutator

setArray

Methods inherited from interface ArrayAccessor.ArrayProperty

letArray

Methods inherited from interface ArrayTransmission

getLength, toSchema, toSequence, toSimpleTypeTable

Methods inherited from interface Schemable

toSchema

Methods inherited from interface Section

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface Section.SectionMixin

receiveFrom

Methods inherited from interface Transmission

reset, transmitTo, transmitTo

Methods inherited from interface Transmission.TransmissionMixin

transmitTo

Constructor Details

SegmentArraySection

public SegmentArraySection(Class<ARRAY> aSegmentClass)

Instantiates the class SegmentArraySection.

Parameters:

aSegmentClass - the segment class

See Also:

• AbstractArrayTransmission(Class)

SegmentArraySection

public SegmentArraySection(Collection<ARRAY> aSegments)

Instantiates the class SegmentArraySection.

Parameters:

aSegments - the segments

See Also:

• AbstractArrayTransmission(Collection)

SegmentArraySection

@SafeVarargs
public SegmentArraySection(ARRAY... aSegments)

Instantiates the class SegmentArraySection.

Parameters:

aSegments - the segments

See Also:

• AbstractArrayTransmission(Transmission...)

SegmentArraySection

public SegmentArraySection(String aAlias,
 Class<ARRAY> aSegmentClass)

Instantiates the class SegmentArraySection.

Parameters:

aAlias - the alias

aSegmentClass - the segment class

See Also:

• AbstractArrayTransmission(String, Class)

SegmentArraySection

public SegmentArraySection(String aAlias,
 Collection<ARRAY> aSegments)

Instantiates the class SegmentArraySection.

Parameters:

aAlias - the alias

aSegments - the segments

See Also:

• AbstractArrayTransmission(String, Collection)

SegmentArraySection

@SafeVarargs
public SegmentArraySection(String aAlias,
 ARRAY... aSegments)

Instantiates the class SegmentArraySection.

Parameters:

aAlias - the alias

aSegments - the segments

See Also:

• AbstractArrayTransmission(String, Transmission...)

SegmentArraySection

public SegmentArraySection(String aAlias,
 TypeFactory<ARRAY> aSegmentFactory,
 Collection<ARRAY> aSegments)

Instantiates the class SegmentArraySection.

Parameters:

aAlias - the alias

aSegmentFactory - the segment factory

aSegments - the segments

See Also:

• AbstractArrayTransmission(String, TypeFactory, Collection)

SegmentArraySection

@SafeVarargs
public SegmentArraySection(String aAlias,
 TypeFactory<ARRAY> aSegmentFactory,
 ARRAY... aSegments)

Instantiates the class SegmentArraySection.

Parameters:

aAlias - the alias

aSegmentFactory - the segment factory

aSegments - the segments

See Also:

• AbstractArrayTransmission(String, TypeFactory, Transmission...)

SegmentArraySection

public SegmentArraySection(String aAlias,
 TypeFactory<ARRAY> aSegmentFactory)

Instantiates the class SegmentArraySection.

Parameters:

aAlias - the alias

aSegmentFactory - the segment factory

See Also:

• AbstractArrayTransmission(String, TypeFactory)

SegmentArraySection

public SegmentArraySection(TypeFactory<ARRAY> aSegmentFactory,
 Collection<ARRAY> aSegments)

Instantiates the class SegmentArraySection.

Parameters:

aSegmentFactory - the segment factory

aSegments - the segments

See Also:

• AbstractArrayTransmission(TypeFactory, Collection)

SegmentArraySection

@SafeVarargs
public SegmentArraySection(TypeFactory<ARRAY> aSegmentFactory,
 ARRAY... aSegments)

Instantiates the class SegmentArraySection.

Parameters:

aSegmentFactory - the segment factory

aSegments - the segments

See Also:

• AbstractArrayTransmission(TypeFactory, Transmission...)

SegmentArraySection

public SegmentArraySection(TypeFactory<ARRAY> aSegmentFactory)

Instantiates the class SegmentArraySection.

Parameters:

aSegmentFactory - the segment factory

See Also:

• AbstractArrayTransmission(TypeFactory)

Method Details

withArray

public SegmentArraySection<ARRAY> withArray(ARRAY[] aValue)

Specified by:

withArray in interface ArrayAccessor.ArrayBuilder<ARRAY extends Segment[], ArrayTransmission<ARRAY extends Segment>>

Overrides:

withArray in class AbstractArrayTransmission<ARRAY extends Segment>

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.