Class MagicBytesSegment

java.lang.Object

org.refcodes.serial.AbstractMagicBytesTransmission

org.refcodes.serial.MagicBytesSegment

All Implemented Interfaces:

Serializable, AliasAccessor, EncodingAccessor<Charset>, LengthAccessor, MagicBytesAccessor, MagicBytesAccessor.MagicBytesMutator, MagicBytesAccessor.MagicBytesProperty, PayloadAccessor<byte[]>, PayloadAccessor.PayloadBuilder<byte[], PayloadTransmission<byte[]>>, PayloadAccessor.PayloadMutator<byte[]>, PayloadAccessor.PayloadProperty<byte[]>, Resetable, Diagnosable, Schemable<DiagnosticOptions>, 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 AliasAccessor

AliasAccessor.AliasBuilder<B>, AliasAccessor.AliasMutator, AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface EncodingAccessor

EncodingAccessor.EncodingBuilder<E,B>, EncodingAccessor.EncodingMutator<E>, EncodingAccessor.EncodingProperty<E>

Nested classes/interfaces inherited from interface LengthAccessor

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

Nested classes/interfaces inherited from interface MagicBytesAccessor

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

Nested classes/interfaces inherited from interface MagicBytesAccessor

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

Nested classes/interfaces inherited from interface MagicBytesLengthAccessor

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

Nested classes/interfaces inherited from interface PayloadAccessor

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

Nested classes/interfaces inherited from interface Segment

Segment.SegmentMixin

Nested classes/interfaces inherited from interface Transmission

Transmission.TransmissionMixin

Field Summary

Fields inherited from class AbstractMagicBytesTransmission

_alias, _charset, _magicBytes, _magicBytesLength

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)	Instantiates the class MagicBytesSegment.
MagicBytesSegment(String aAlias, byte[] aMagicBytes, TransmissionMetrics aTransmissionMetrics)	Constructs an according instance for magic bytes of the given length.
MagicBytesSegment(String aAlias, int aMagicBytesLength)	Instantiates the class MagicBytesSegment.
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 AbstractMagicBytesTransmission

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

Methods inherited from class Object

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

Methods inherited from interface MagicBytesAccessor

toMagicBytes, toMagicBytes

Methods inherited from interface MagicBytesAccessor.MagicBytesProperty

letMagicBytes, letMagicBytes

Methods inherited from interface MagicBytesAccessor.MagicBytesProperty

letMagicBytes

Methods inherited from interface PayloadAccessor

getPayloadOr

Methods inherited from interface PayloadAccessor.PayloadProperty

letPayload

Methods inherited from interface Schemable

toSchema, toSchema

Methods inherited from interface Segment

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface Segment.SegmentMixin

receiveFrom

Methods inherited from interface Transmission

reset, toSimpleTypeTable, transmitTo, transmitTo

Methods inherited from interface 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)

Instantiates the class MagicBytesSegment.

Parameters:

aAlias - the alias

aMagicBytesLength - the magic bytes length

See Also:

• AbstractMagicBytesTransmission(String, int)

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)

Instantiates the class MagicBytesSegment.

Parameters:

aAlias - the alias

aMagicBytes - the magic bytes

See Also:

• AbstractMagicBytesTransmission(String, byte)

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 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 PayloadAccessor.PayloadBuilder<byte[], PayloadTransmission<byte[]>>