Class ByteArraySection

java.lang.Object

org.refcodes.serial.AbstractPayloadSection<byte[]>

org.refcodes.serial.ByteArraySection

All Implemented Interfaces:

Serializable, AliasAccessor, LengthAccessor, PayloadAccessor<byte[]>, PayloadAccessor.PayloadBuilder<byte[], PayloadTransmission<byte[]>>, PayloadAccessor.PayloadMutator<byte[]>, PayloadAccessor.PayloadProperty<byte[]>, Resetable, Diagnosable, Schemable<DiagnosticOptions>, PayloadSection<byte[]>, PayloadTransmission<byte[]>, Section, Section.SectionMixin, Transmission, Transmission.TransmissionMixin

public class ByteArraySection
extends AbstractPayloadSection<byte[]>

The ByteArraySection is an implementation of a Section carrying a byte array as payload.

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 LengthAccessor

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

Nested classes/interfaces inherited from interface PayloadAccessor

PayloadAccessor.PayloadBuilder<P,B>, PayloadAccessor.PayloadMutator<P>, PayloadAccessor.PayloadProperty<P>

Nested classes/interfaces inherited from interface Section

Section.SectionMixin

Nested classes/interfaces inherited from interface Transmission

Transmission.TransmissionMixin

Field Summary

Fields inherited from class AbstractPayloadSection

_alias, _payload

Constructor Summary

Constructors

Constructor	Description
ByteArraySection()	Constructs an empty ByteArraySection.
ByteArraySection(byte[] aPayload)	Constructs a ByteArraySection with the given byte array payload.
ByteArraySection(Byte[] aPayload)	Constructs a ByteArraySection with the given byte array payload.
ByteArraySection(String aAlias)	Instantiates the class ByteArraySection.
ByteArraySection(String aAlias, byte[] aPayload)	Instantiates the class ByteArraySection.
ByteArraySection(String aAlias, Byte[] aPayload)	Instantiates the class ByteArraySection.

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.
int	getLength()	Determines the overall length of this Transmission.
void	setPayload(Byte[] aPayload)	Convenience method to convert the array of wrapper types into its counterpart with primitive types before invoking AbstractPayloadSection.setPayload(Object).
Schema	toSchema()
Sequence	toSequence()	Provides the Sequence representation of this Transmission.
String	toString()
ByteArraySection	withPayload(byte[] aValue)
ByteArraySection	withPayload(Byte[] aPayload)	Convenience method to convert the array of wrapper types into its counterpart with primitive types before invoking withPayload(byte[]).

Methods inherited from class AbstractPayloadSection

equals, getAlias, getPayload, hashCode, reset, setPayload, toSimpleTypeTable

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface PayloadAccessor

getPayloadOr

Methods inherited from interface PayloadAccessor.PayloadProperty

letPayload

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

transmitTo, transmitTo

Methods inherited from interface Transmission.TransmissionMixin

transmitTo

Constructor Details

ByteArraySection

public ByteArraySection()

Constructs an empty ByteArraySection.

ByteArraySection

public ByteArraySection(byte[] aPayload)

Constructs a ByteArraySection with the given byte array payload.

Parameters:

aPayload - The payload to be contained by the Section.

ByteArraySection

public ByteArraySection(Byte[] aPayload)

Constructs a ByteArraySection with the given byte array payload.

Parameters:

aPayload - The payload to be contained by the Section.

ByteArraySection

public ByteArraySection(String aAlias)

Instantiates the class ByteArraySection.

Parameters:

aAlias - the alias

See Also:

• AbstractPayloadSection(String, Object)

ByteArraySection

public ByteArraySection(String aAlias,
 byte[] aPayload)

Instantiates the class ByteArraySection.

Parameters:

aAlias - the alias

aPayload - the payload

See Also:

• AbstractPayloadSection(String, Object)

ByteArraySection

public ByteArraySection(String aAlias,
 Byte[] aPayload)

Instantiates the class ByteArraySection.

Parameters:

aAlias - the alias

aPayload - The payload to be contained by the Section.

See Also:

• AbstractPayloadSection(String, Object)

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.

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.

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.

Returns:

The (overall) length of the Transmission (including any sub-segments).

toSchema

public Schema toSchema()

toString

public String toString()

Overrides:

toString in class AbstractPayloadSection<byte[]>

withPayload

public ByteArraySection withPayload(byte[] aValue)

setPayload

public void setPayload(Byte[] aPayload)

Convenience method to convert the array of wrapper types into its counterpart with primitive types before invoking AbstractPayloadSection.setPayload(Object).

Parameters:

aPayload - The payload with the wrapper types.

withPayload

public ByteArraySection withPayload(Byte[] aPayload)

Convenience method to convert the array of wrapper types into its counterpart with primitive types before invoking withPayload(byte[]).

Parameters:

aPayload - The payload with the wrapper types.

Returns:

This instance as of the builder pattern.