Module org.refcodes.serial

Package org.refcodes.serial

Interface PacketMagicBytesAccessor.PacketMagicBytesProperty

All Superinterfaces:

PacketMagicBytesAccessor, PacketMagicBytesAccessor.PacketMagicBytesMutator

All Known Implementing Classes:

TransmissionMetricsBuilder

Enclosing interface:

PacketMagicBytesAccessor

public static interface PacketMagicBytesAccessor.PacketMagicBytesProperty
extends PacketMagicBytesAccessor, PacketMagicBytesAccessor.PacketMagicBytesMutator

Provides a packet magic bytes property.

Nested Class Summary

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

PacketMagicBytesAccessor.PacketMagicBytesBuilder<B extends PacketMagicBytesAccessor.PacketMagicBytesBuilder<B>>, PacketMagicBytesAccessor.PacketMagicBytesMutator, PacketMagicBytesAccessor.PacketMagicBytesProperty

Method Summary

Modifier and Type	Method	Description
default byte[]	letPacketMagicBytes(byte[] aPacketMagicBytes)	This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given character (setter) as of PacketMagicBytesAccessor.PacketMagicBytesMutator.setPacketMagicBytes(byte[]) and returns the very same value (getter).
default String	letPacketMagicBytes(String aPacketMagicBytes)	This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given character (setter) as of PacketMagicBytesAccessor.PacketMagicBytesMutator.setPacketMagicBytes(byte[]) and returns the very same value (getter).
default String	letPacketMagicBytes(String aPacketMagicBytes, 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 letPacketMagicBytes(byte[]) and returns the very same value (getter).

Methods inherited from interface org.refcodes.serial.PacketMagicBytesAccessor

getPacketMagicBytes

Methods inherited from interface org.refcodes.serial.PacketMagicBytesAccessor.PacketMagicBytesMutator

setPacketMagicBytes, setPacketMagicBytes, setPacketMagicBytes

Method Details

letPacketMagicBytes

default byte[] letPacketMagicBytes(byte[] aPacketMagicBytes)

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

Parameters:

aPacketMagicBytes - The character to set (via PacketMagicBytesAccessor.PacketMagicBytesMutator.setPacketMagicBytes(byte[])).

Returns:

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

letPacketMagicBytes

default String letPacketMagicBytes(String aPacketMagicBytes)

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

Parameters:

aPacketMagicBytes - The character to set (via PacketMagicBytesAccessor.PacketMagicBytesMutator.setPacketMagicBytes(byte[])).

Returns:

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

letPacketMagicBytes

default String letPacketMagicBytes(String aPacketMagicBytes,
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 letPacketMagicBytes(byte[]) and returns the very same value (getter).

Parameters:

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