Module org.refcodes.serial

Package org.refcodes.serial

Class MagicBytesSegment

java.lang.Object

org.refcodes.serial.AbstractMagicBytesTransmission

org.refcodes.serial.MagicBytesSegment

All Implemented Interfaces:

Serializable, org.refcodes.mixin.AliasAccessor, 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.Resetable, org.refcodes.schema.Schemable, MagicBytesAccessor, MagicBytesAccessor.MagicBytesMutator, MagicBytesAccessor.MagicBytesProperty, MagicBytesLengthAccessor, PayloadTransmission<byte[]>, Segment, Segment.SegmentMixin, Transmission, Transmission.TransmissionMixin

Direct Known Subclasses:

AssertMagicBytesSegment

public class MagicBytesSegment
extends AbstractMagicBytesTransmission
implements Segment.SegmentMixin, Segment

Magic bytes are usually found (somewhere) at the beginning of a file or a stream. A MagicBytesSegment decorates a Segment decoratee and prefixes this Segment instance with given magic bytes.

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

org.refcodes.mixin.EncodingAccessor.EncodingBuilder<E,B extends org.refcodes.mixin.EncodingAccessor.EncodingBuilder<E,B>>, org.refcodes.mixin.EncodingAccessor.EncodingMutator<E>, org.refcodes.mixin.EncodingAccessor.EncodingProperty<E>

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,B extends org.refcodes.mixin.PayloadAccessor.PayloadBuilder<P,B>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<P>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<P>

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

_alias, _charset, _magicBytes, _magicBytesLength, MAGIC_BYTES, MAGIC_BYTES_TEXT

Constructor Summary

Constructors

Constructor	Description
MagicBytesSegment(byte... aMagicBytes)	Constructs an according instance with the according magic bytes.
MagicBytesSegment(byte[] aMagicBytes, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance for magic bytes of the given length.
MagicBytesSegment(int aMagicBytesLength)	Constructs an according instance with magic bytes of the given length.
MagicBytesSegment(String aMagicBytes)	Constructs an according instance with the according magic bytes (retrieved from the given String).
MagicBytesSegment(String aAlias, byte... aMagicBytes)	Constructs an according instance with the according magic bytes.
MagicBytesSegment(String aAlias, byte[] aMagicBytes, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance for magic bytes of the given length.
MagicBytesSegment(String aAlias, int aMagicBytesLength)	Constructs an according instance with magic bytes of the given length.
MagicBytesSegment(String aAlias, String aMagicBytes)	Constructs an according instance with the according magic bytes (retrieved from the given String).
MagicBytesSegment(String aAlias, String aMagicBytes, Charset aCharset)	Constructs an according instance with the according magic bytes (retrieved from the given String).
MagicBytesSegment(String aAlias, String aMagicBytes, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance for magic bytes of the given length.
MagicBytesSegment(String aMagicBytes, Charset aCharset)	Constructs an according instance with the according magic bytes (retrieved from the given String).
MagicBytesSegment(String aMagicBytes, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance for magic bytes of the given length.
MagicBytesSegment(TransmissionMetrics aTransmissionMetrics)	Constructs an according instance for magic bytes of the given length.

Method Summary

Modifier and Type	Method	Description
int	fromTransmission(Sequence aSequence, int aOffset)	(Re-)initializes this instance with the the given Sequence data.
int	getLength()	Determines the overall length of this Transmission.
Sequence	toSequence()	Provides the Sequence representation of this Transmission.
MagicBytesSegment	withPayload(byte[] aValue)

Methods inherited from class org.refcodes.serial.AbstractMagicBytesTransmission

equals, getAlias, getEncoding, getMagicBytes, getMagicBytesLength, getPayload, hashCode, reset, setMagicBytes, setMagicBytes, setMagicBytes, setPayload, toMagicBytesString, toMagicBytesString, toSchema, toSimpleTypeMap, toString

Methods inherited from class java.lang.Object

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

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

receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

reset, toSchema, toSimpleTypeMap, transmitTo, transmitTo

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

transmitTo

Constructor Details

MagicBytesSegment

public MagicBytesSegment(String aAlias,
 String aMagicBytes,
 TransmissionMetrics aTransmissionMetrics)

Constructs an according instance for magic bytes of the given length. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aAlias - The alias which identifies the content of this segment.

aMagicBytes - The String to be stored by this instance as magic bytes.

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

MagicBytesSegment

public MagicBytesSegment(String aAlias,
 byte[] aMagicBytes,
 TransmissionMetrics aTransmissionMetrics)

Constructs an according instance for magic bytes of the given length. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aAlias - The alias which identifies the content of this segment.

aMagicBytes - The bytes to be stored by this instance as magic bytes.

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

MagicBytesSegment

public MagicBytesSegment(TransmissionMetrics aTransmissionMetrics)

Constructs an according instance for magic bytes of the given length. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

MagicBytesSegment

public MagicBytesSegment(String aMagicBytes,
 TransmissionMetrics aTransmissionMetrics)

Constructs an according instance for magic bytes of the given length. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aMagicBytes - The String to be stored by this instance as magic bytes.

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

MagicBytesSegment

public MagicBytesSegment(byte[] aMagicBytes,
 TransmissionMetrics aTransmissionMetrics)

Constructs an according instance for magic bytes of the given length. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aMagicBytes - The bytes to be stored by this instance as magic bytes.

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

MagicBytesSegment

public MagicBytesSegment(int aMagicBytesLength)

Constructs an according instance with magic bytes of the given length.

Parameters:

aMagicBytesLength - The length of the magic bytes sequence..

MagicBytesSegment

public MagicBytesSegment(String aMagicBytes)

Constructs an according instance with the according magic bytes (retrieved from the given String).

Parameters:

aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).

MagicBytesSegment

public MagicBytesSegment(String aMagicBytes,
 Charset aCharset)

Constructs an according instance with the according magic bytes (retrieved from the given String).

Parameters:

aMagicBytes - The String to be stored by this instance as magic bytes.

aCharset - The Charset to use when converting the String to a byte array.

MagicBytesSegment

public MagicBytesSegment(byte... aMagicBytes)

Constructs an according instance with the according magic bytes.

Parameters:

aMagicBytes - The magic bytes to be stored by this instance.

MagicBytesSegment

public MagicBytesSegment(String aAlias,
 int aMagicBytesLength)

Constructs an according instance with magic bytes of the given length.

Parameters:

aAlias - The alias which identifies the content of this segment.

aMagicBytesLength - The length of the magic bytes sequence..

MagicBytesSegment

public MagicBytesSegment(String aAlias,
 String aMagicBytes)

Constructs an according instance with the according magic bytes (retrieved from the given String).

Parameters:

aAlias - The alias which identifies the content of this segment.

aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).

MagicBytesSegment

public MagicBytesSegment(String aAlias,
 String aMagicBytes,
 Charset aCharset)

Constructs an according instance with the according magic bytes (retrieved from the given String).

Parameters:

aAlias - The alias which identifies the content of this segment.

aMagicBytes - The String to be stored by this instance as magic bytes.

aCharset - The Charset to use when converting the String to a byte array.

MagicBytesSegment

public MagicBytesSegment(String aAlias,
 byte... aMagicBytes)

Constructs an according instance with the according magic bytes.

Parameters:

aAlias - The alias which identifies the content of this segment.

aMagicBytes - The magic bytes to be stored by this instance.

Method Details

fromTransmission

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

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

Specified by:

fromTransmission in interface 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.

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.

Specified by:

toSequence in interface Transmission

Overrides:

toSequence in class AbstractMagicBytesTransmission

Returns:

The according instance's Sequence.

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.

Specified by:

getLength in interface org.refcodes.mixin.LengthAccessor

Specified by:

getLength in interface Transmission

Returns:

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

withPayload

public MagicBytesSegment withPayload(byte[] aValue)

Specified by:

withPayload in interface org.refcodes.mixin.PayloadAccessor.PayloadBuilder<byte[],PayloadTransmission<byte[]>>