Module org.refcodes.serial

Package org.refcodes.serial

Interface MagicBytesAccessor

All Superinterfaces:

org.refcodes.mixin.MagicBytesAccessor

All Known Subinterfaces:

MagicBytesAccessor.MagicBytesProperty

All Known Implementing Classes:

AbstractMagicBytesTransmission, AbstractMagicBytesTransmissionDecorator, AssertMagicBytesSectionDecorator, AssertMagicBytesSegment, AssertMagicBytesSegmentDecorator, BadMagicBytesException, BadMagicBytesSequenceException, MagicBytes, MagicBytesSectionDecorator, MagicBytesSegment, MagicBytesSegmentDecorator

public interface MagicBytesAccessor
extends org.refcodes.mixin.MagicBytesAccessor

Provides an accessor for a magic byte array property.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MagicBytesAccessor.MagicBytesBuilder<B extends MagicBytesAccessor.MagicBytesBuilder<B>>	Provides a builder method for a magic byte array property returning the builder for applying multiple build operations.
static interface	MagicBytesAccessor.MagicBytesMutator	Provides a mutator for a magic byte array property.
static interface	MagicBytesAccessor.MagicBytesProperty	Provides a magic byte array property.

Method Summary

Modifier and Type	Method	Description
default String	toMagicBytes()	Returns the magic bytes (as of MagicBytesAccessor.getMagicBytes()) String being UTF-8 encoded.
default String	toMagicBytes(Charset aCharset)	Returns the magic bytes (as of MagicBytesAccessor.getMagicBytes()) as an accordingly encoded String.

Methods inherited from interface org.refcodes.mixin.MagicBytesAccessor

getMagicBytes

Method Details

toMagicBytes

default String toMagicBytes()

Returns the magic bytes (as of MagicBytesAccessor.getMagicBytes()) String being UTF-8 encoded.

Returns:

The according magic bytes String.

toMagicBytes

default String toMagicBytes(Charset aCharset)

Returns the magic bytes (as of MagicBytesAccessor.getMagicBytes()) as an accordingly encoded String.

Parameters:

aCharset - The Charset to use for encoding.

Returns:

The accordingly encoded magic bytes String.