Class FixedSegmentArraySection<ARRAY extends Segment>

java.lang.Object

org.refcodes.serial.AbstractArrayTransmission<ARRAY>

org.refcodes.serial.FixedSegmentArraySection<ARRAY>

Type Parameters:

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

All Implemented Interfaces:

Serializable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.ArrayAccessor<ARRAY[]>, org.refcodes.mixin.ArrayAccessor.ArrayBuilder<ARRAY[],ArrayTransmission<ARRAY>>, org.refcodes.mixin.ArrayAccessor.ArrayMutator<ARRAY[]>, org.refcodes.mixin.ArrayAccessor.ArrayProperty<ARRAY[]>, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.Resetable, org.refcodes.schema.Schemable, ArraySection<ARRAY>, ArrayTransmission<ARRAY>, Section, Section.SectionMixin, Transmission, Transmission.TransmissionMixin

public class FixedSegmentArraySection<ARRAY extends Segment>
extends AbstractArrayTransmission<ARRAY>
implements ArraySection<ARRAY>

A FixedSegmentArraySection is a Section consisting of Segment elements with each element of the same (uniform) length (in contrast to the SegmentArraySection). When using the FixedSegmentArraySection, it is to be taken care of the uniform Segment elements' lengths.

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

org.refcodes.mixin.ArrayAccessor.ArrayBuilder<T,B extends org.refcodes.mixin.ArrayAccessor.ArrayBuilder<T,B>>, org.refcodes.mixin.ArrayAccessor.ArrayMutator<T>, org.refcodes.mixin.ArrayAccessor.ArrayProperty<T>

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

Section.SectionMixin

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

Transmission.TransmissionMixin

Field Summary

Fields inherited from class org.refcodes.serial.AbstractArrayTransmission

_alias, _array, _sequenceableFactory

Constructor Summary

Constructors

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

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

Methods inherited from class org.refcodes.serial.AbstractArrayTransmission

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.AliasAccessor

getAlias

Methods inherited from interface org.refcodes.mixin.ArrayAccessor

getArray

Methods inherited from interface org.refcodes.mixin.ArrayAccessor.ArrayMutator

setArray

Methods inherited from interface org.refcodes.mixin.ArrayAccessor.ArrayProperty

letArray

Methods inherited from interface org.refcodes.serial.ArrayTransmission

getLength, toSchema, toSequence, toSimpleTypeTable

Methods inherited from interface org.refcodes.schema.Schemable

toSchema

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

reset, transmitTo, transmitTo

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

transmitTo

Constructor Details

FixedSegmentArraySection

public FixedSegmentArraySection(Class<ARRAY> aSegmentClass)

Instantiates the class FixedSegmentArraySection.

Parameters:

aSegmentClass - the segment class

See Also:

• AbstractArrayTransmission(Class)

FixedSegmentArraySection

public FixedSegmentArraySection(Collection<ARRAY> aSegments)

Instantiates the class FixedSegmentArraySection.

Parameters:

aSegments - the segments

See Also:

• AbstractArrayTransmission(Collection)

FixedSegmentArraySection

@SafeVarargs
public FixedSegmentArraySection(ARRAY... aSegments)

Instantiates the class FixedSegmentArraySection.

Parameters:

aSegments - the segments

See Also:

• AbstractArrayTransmission(Transmission...)

FixedSegmentArraySection

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

Instantiates the class FixedSegmentArraySection.

Parameters:

aAlias - the alias

aSegmentClass - the segment class

See Also:

• AbstractArrayTransmission(String, Class)

FixedSegmentArraySection

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

Instantiates the class FixedSegmentArraySection.

Parameters:

aAlias - the alias

aSegments - the segments

See Also:

• AbstractArrayTransmission(String, Collection)

FixedSegmentArraySection

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

Instantiates the class FixedSegmentArraySection.

Parameters:

aAlias - the alias

aSegments - the segments

See Also:

• AbstractArrayTransmission(String, Transmission...)

FixedSegmentArraySection

public FixedSegmentArraySection(String aAlias,
 org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory,
 Collection<ARRAY> aSegments)

Instantiates the class FixedSegmentArraySection.

Parameters:

aAlias - the alias

aSegmentFactory - the segment factory

aSegments - the segments

See Also:

• AbstractArrayTransmission(String, TypeFactory, Collection)

FixedSegmentArraySection

@SafeVarargs
public FixedSegmentArraySection(String aAlias,
 org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory,
 ARRAY... aSegments)

Instantiates the class FixedSegmentArraySection.

Parameters:

aAlias - the alias

aSegmentFactory - the segment factory

aSegments - the segments

See Also:

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

FixedSegmentArraySection

public FixedSegmentArraySection(String aAlias,
 org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory)

Instantiates the class FixedSegmentArraySection.

Parameters:

aAlias - the alias

aSegmentFactory - the segment factory

See Also:

• AbstractArrayTransmission(String, TypeFactory)

FixedSegmentArraySection

public FixedSegmentArraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory,
 Collection<ARRAY> aSegments)

Instantiates the class FixedSegmentArraySection.

Parameters:

aSegmentFactory - the segment factory

aSegments - the segments

See Also:

• AbstractArrayTransmission(TypeFactory, Collection)

FixedSegmentArraySection

@SafeVarargs
public FixedSegmentArraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory,
 ARRAY... aSegments)

Instantiates the class FixedSegmentArraySection.

Parameters:

aSegmentFactory - the segment factory

aSegments - the segments

See Also:

• AbstractArrayTransmission(TypeFactory, Transmission...)

FixedSegmentArraySection

public FixedSegmentArraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory)

Instantiates the class FixedSegmentArraySection.

Parameters:

aSegmentFactory - the segment factory

See Also:

• AbstractArrayTransmission(TypeFactory)

Method Details

withArray

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

Specified by:

withArray in interface org.refcodes.mixin.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.