Module org.refcodes.serial

Package org.refcodes.serial

Class AssertMagicBytesSectionDecorator<DECORATEE extends Section>

java.lang.Object

org.refcodes.serial.AbstractMagicBytesTransmission

org.refcodes.serial.AbstractMagicBytesTransmissionDecorator<DECORATEE>

org.refcodes.serial.MagicBytesSectionDecorator<DECORATEE>

org.refcodes.serial.AssertMagicBytesSectionDecorator<DECORATEE>

Type Parameters:

DECORATEE - The Segment type describing the Segment subclass decoratee.

All Implemented Interfaces:

Serializable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.DecorateeAccessor<DECORATEE>, org.refcodes.mixin.EncodingAccessor<Charset>, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.MagicBytesAccessor, org.refcodes.mixin.MagicBytesAccessor.MagicBytesMutator, org.refcodes.mixin.MagicBytesAccessor.MagicBytesProperty, org.refcodes.mixin.PayloadAccessor<byte[]>, org.refcodes.mixin.PayloadAccessor.PayloadBuilder<byte[],PayloadTransmission<byte[]>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<byte[]>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<byte[]>, org.refcodes.mixin.Schemable<SerialSchema>, DecoratorSection<DECORATEE>, MagicBytesAccessor, MagicBytesAccessor.MagicBytesMutator, MagicBytesAccessor.MagicBytesProperty, MagicBytesLengthAccessor, PayloadTransmission<byte[]>, Section, Section.SectionMixin, Transmission, Transmission.TransmissionMixin

public class AssertMagicBytesSectionDecorator<DECORATEE extends Section>
extends MagicBytesSectionDecorator<DECORATEE>

The AssertMagicBytesSectionDecorator extends the MagicBytesSectionDecorator and enforces the configured magic bytes to match the received magic bytes (as of fromTransmission(Sequence, int, int) and receiveFrom(java.io.InputStream, int, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.

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

org.refcodes.mixin.DecorateeAccessor.DecorateeBuilder<DECORATEE extends Object,B extends org.refcodes.mixin.DecorateeAccessor.DecorateeBuilder<DECORATEE,B>>, org.refcodes.mixin.DecorateeAccessor.DecorateeMutator<DECORATEE extends Object>, org.refcodes.mixin.DecorateeAccessor.DecorateeProperty<DECORATEE extends Object>

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

org.refcodes.mixin.MagicBytesAccessor.MagicBytesBuilder<B extends org.refcodes.mixin.MagicBytesAccessor.MagicBytesBuilder<B>>, org.refcodes.mixin.MagicBytesAccessor.MagicBytesMutator, org.refcodes.mixin.MagicBytesAccessor.MagicBytesProperty

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

MagicBytesAccessor.MagicBytesBuilder<B extends MagicBytesAccessor.MagicBytesBuilder<B>>, MagicBytesAccessor.MagicBytesMutator, MagicBytesAccessor.MagicBytesProperty

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

MagicBytesLengthAccessor.MagicBytesLengthBuilder<B extends MagicBytesLengthAccessor.MagicBytesLengthBuilder<B>>, MagicBytesLengthAccessor.MagicBytesLengthMutator, MagicBytesLengthAccessor.MagicBytesLengthProperty

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

_alias, _decoratee

Fields inherited from class org.refcodes.serial.AbstractMagicBytesTransmission

_charset, _magicBytes, _magicBytesLength, MAGIC_BYTES, MAGIC_BYTES_TEXT

Constructor Summary

Constructors

Constructor	Description
AssertMagicBytesSectionDecorator(DECORATEE aDecoratee, byte... aMagicBytes)
AssertMagicBytesSectionDecorator(DECORATEE aDecoratee, String aMagicBytes)
AssertMagicBytesSectionDecorator(DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)
AssertMagicBytesSectionDecorator(String aAlias, DECORATEE aDecoratee, byte... aMagicBytes)
AssertMagicBytesSectionDecorator(String aAlias, DECORATEE aDecoratee, String aMagicBytes)
AssertMagicBytesSectionDecorator(String aAlias, DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)

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.
void	receiveFrom(InputStream aInputStream, int aLength, OutputStream aReturnStream)	Default implementation harnessing the Section.fromTransmission(Sequence, int) method.
SerialSchema	toSchema()	Retrieves the SerialSchema representing the Transmission.

Methods inherited from class org.refcodes.serial.MagicBytesSectionDecorator

withPayload

Methods inherited from class org.refcodes.serial.AbstractMagicBytesTransmissionDecorator

equals, getAlias, getDecoratee, getLength, hashCode, setPayload, toSequence, toString

Methods inherited from class org.refcodes.serial.AbstractMagicBytesTransmission

getEncoding, getMagicBytes, getMagicBytesLength, getPayload, setMagicBytes, setMagicBytes, setMagicBytes, toMagicBytesString, toMagicBytesString, toSimpleTypeMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.DecorateeAccessor

getDecoratee

Methods inherited from interface org.refcodes.serial.MagicBytesAccessor

toMagicBytes, toMagicBytes

Methods inherited from interface org.refcodes.mixin.MagicBytesAccessor.MagicBytesProperty

letMagicBytes, letMagicBytes

Methods inherited from interface org.refcodes.serial.MagicBytesAccessor.MagicBytesProperty

letMagicBytes

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

getLength, toSequence, toSimpleTypeMap, transmitTo, transmitTo

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

transmitTo

Constructor Details

AssertMagicBytesSectionDecorator

public AssertMagicBytesSectionDecorator(DECORATEE aDecoratee,
 byte... aMagicBytes)

AssertMagicBytesSectionDecorator

public AssertMagicBytesSectionDecorator(DECORATEE aDecoratee,
 String aMagicBytes,
 Charset aCharset)

AssertMagicBytesSectionDecorator

public AssertMagicBytesSectionDecorator(DECORATEE aDecoratee,
 String aMagicBytes)

AssertMagicBytesSectionDecorator

public AssertMagicBytesSectionDecorator(String aAlias,
 DECORATEE aDecoratee,
 byte... aMagicBytes)

AssertMagicBytesSectionDecorator

public AssertMagicBytesSectionDecorator(String aAlias,
 DECORATEE aDecoratee,
 String aMagicBytes,
 Charset aCharset)

AssertMagicBytesSectionDecorator

public AssertMagicBytesSectionDecorator(String aAlias,
 DECORATEE aDecoratee,
 String aMagicBytes)

Method Details

fromTransmission

public void fromTransmission(Sequence aSequence,
 int aOffset,
 int aLength)
                      throws BadMagicBytesSequenceException,
TransmissionException

(Re-)initializes this instance with the the given Sequence data.

Specified by:

fromTransmission in interface Section

Overrides:

fromTransmission in class MagicBytesSectionDecorator<DECORATEE extends 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.

BadMagicBytesSequenceException

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

Overrides:

receiveFrom in class MagicBytesSectionDecorator<DECORATEE extends Section>

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.

toSchema

public SerialSchema toSchema()

Retrieves the SerialSchema representing the Transmission. Retrieving a SerialSchema 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 org.refcodes.mixin.Schemable<DECORATEE extends Section>

Specified by:

toSchema in interface Transmission

Overrides:

toSchema in class MagicBytesSectionDecorator<DECORATEE extends Section>

Returns:

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