Module org.refcodes.serial

Package org.refcodes.serial

Interface TransmissionMagicBytesAccessor.TransmissionMagicBytesProperty

All Superinterfaces:

TransmissionMagicBytesAccessor, TransmissionMagicBytesAccessor.TransmissionMagicBytesMutator

All Known Implementing Classes:

TransmissionMetricsBuilder

Enclosing interface:

TransmissionMagicBytesAccessor

public static interface TransmissionMagicBytesAccessor.TransmissionMagicBytesProperty
extends TransmissionMagicBytesAccessor, TransmissionMagicBytesAccessor.TransmissionMagicBytesMutator

Provides a transmission magic bytes property.

Nested Class Summary

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

TransmissionMagicBytesAccessor.TransmissionMagicBytesBuilder<B extends TransmissionMagicBytesAccessor.TransmissionMagicBytesBuilder<B>>, TransmissionMagicBytesAccessor.TransmissionMagicBytesMutator, TransmissionMagicBytesAccessor.TransmissionMagicBytesProperty

Method Summary

Modifier and Type	Method	Description
default byte[]	letTransmissionMagicBytes(byte[] aTransmissionMagicBytes)	This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given character (setter) as of TransmissionMagicBytesAccessor.TransmissionMagicBytesMutator.setTransmissionMagicBytes(byte[]) and returns the very same value (getter).
default String	letTransmissionMagicBytes(String aTransmissionMagicBytes)	This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given character (setter) as of TransmissionMagicBytesAccessor.TransmissionMagicBytesMutator.setTransmissionMagicBytes(byte[]) and returns the very same value (getter).
default String	letTransmissionMagicBytes(String aTransmissionMagicBytes, Charset aEncoding)	This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given byte array (setter) as of letTransmissionMagicBytes(byte[]) and returns the very same value (getter).

Methods inherited from interface org.refcodes.serial.TransmissionMagicBytesAccessor

getTransmissionMagicBytes

Methods inherited from interface org.refcodes.serial.TransmissionMagicBytesAccessor.TransmissionMagicBytesMutator

setTransmissionMagicBytes, setTransmissionMagicBytes, setTransmissionMagicBytes

Method Detail

letTransmissionMagicBytes

default byte[] letTransmissionMagicBytes(byte[] aTransmissionMagicBytes)

This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given character (setter) as of TransmissionMagicBytesAccessor.TransmissionMagicBytesMutator.setTransmissionMagicBytes(byte[]) and returns the very same value (getter).

Parameters:

aTransmissionMagicBytes - The character to set (via TransmissionMagicBytesAccessor.TransmissionMagicBytesMutator.setTransmissionMagicBytes(byte[])).

Returns:

Returns the value passed for it to be used in conclusive processing steps.

letTransmissionMagicBytes

default String letTransmissionMagicBytes(String aTransmissionMagicBytes)

This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given character (setter) as of TransmissionMagicBytesAccessor.TransmissionMagicBytesMutator.setTransmissionMagicBytes(byte[]) and returns the very same value (getter). Uses TransmissionMetrics.DEFAULT_ENCODING for converting the String into a byte array.

Parameters:

aTransmissionMagicBytes - The character to set (via TransmissionMagicBytesAccessor.TransmissionMagicBytesMutator.setTransmissionMagicBytes(byte[])).

Returns:

Returns the value passed for it to be used in conclusive processing steps.

letTransmissionMagicBytes

default String letTransmissionMagicBytes(String aTransmissionMagicBytes,
                                         Charset aEncoding)

This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given byte array (setter) as of letTransmissionMagicBytes(byte[]) and returns the very same value (getter).

Parameters:

aTransmissionMagicBytes - The magic bytes to be stored by the magic bytes property.

aEncoding - The string's bytes are converted using the given Charset.

Returns:

Returns the value passed for it to be used in conclusive processing steps.