Module org.refcodes.serial

Package org.refcodes.serial

Class AssertMagicBytesSegmentDecorator<DECORATEE extends Segment>

java.lang.Object

org.refcodes.serial.AbstractMagicBytesTransmission

org.refcodes.serial.AbstractMagicBytesTransmissionDecorator<DECORATEE>

org.refcodes.serial.MagicBytesSegmentDecorator<DECORATEE>

org.refcodes.serial.AssertMagicBytesSegmentDecorator<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[]>, DecoratorSegment<DECORATEE>, MagicBytesAccessor, MagicBytesAccessor.MagicBytesMutator, MagicBytesAccessor.MagicBytesProperty, MagicBytesLengthAccessor, PayloadTransmission<byte[]>, Segment, Segment.SegmentMixin, Transmission, Transmission.TransmissionMixin

public class AssertMagicBytesSegmentDecorator<DECORATEE extends Segment>
extends MagicBytesSegmentDecorator<DECORATEE>

The AssertMagicBytesSegmentDecorator extends the MagicBytesSegmentDecorator and enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and receiveFrom(java.io.InputStream, 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.Segment

Segment.SegmentMixin

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
AssertMagicBytesSegmentDecorator(DECORATEE aDecoratee, byte... aMagicBytes)
AssertMagicBytesSegmentDecorator(DECORATEE aDecoratee, String aMagicBytes)
AssertMagicBytesSegmentDecorator(DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)
AssertMagicBytesSegmentDecorator(String aAlias, DECORATEE aDecoratee, byte... aMagicBytes)
AssertMagicBytesSegmentDecorator(String aAlias, DECORATEE aDecoratee, String aMagicBytes)
AssertMagicBytesSegmentDecorator(String aAlias, DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)

Method Summary

Modifier and Type	Method	Description
int	fromTransmission(Sequence aSequence, int aOffset)	(Re-)initializes this instance with the the given Sequence data.
void	receiveFrom(InputStream aInputStream, OutputStream aReturnStream)	Default implementation harnessing the Segment.fromTransmission(Sequence) method.
Schema	toSchema()	Retrieves the Schema representing the Transmission.

Methods inherited from class org.refcodes.serial.MagicBytesSegmentDecorator

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

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 Detail

AssertMagicBytesSegmentDecorator

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

AssertMagicBytesSegmentDecorator

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

AssertMagicBytesSegmentDecorator

public AssertMagicBytesSegmentDecorator(DECORATEE aDecoratee,
                                        String aMagicBytes)

AssertMagicBytesSegmentDecorator

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

AssertMagicBytesSegmentDecorator

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

AssertMagicBytesSegmentDecorator

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

Method Detail

fromTransmission

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

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

Specified by:

fromTransmission in interface Segment

Overrides:

fromTransmission in class MagicBytesSegmentDecorator<DECORATEE extends Segment>

Parameters:

aSequence - The Sequence data from which to (re-)initialize this instance.

aOffset - The offset where to start processing the provided Sequence.

Returns:

The index after the last offset into the given Sequence processed by this method.

Throws:

TransmissionException - thrown in case a given Sequence cannot be processed.

BadMagicBytesSequenceException

receiveFrom

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

Default implementation harnessing the Segment.fromTransmission(Sequence) 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 Segment

Specified by:

receiveFrom in interface Segment.SegmentMixin

Overrides:

receiveFrom in class MagicBytesSegmentDecorator<DECORATEE extends Segment>

Parameters:

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

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 transmission cannot be processed.

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

Overrides:

toSchema in class MagicBytesSegmentDecorator<DECORATEE extends Segment>

Returns:

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