Module org.refcodes.serial

Package org.refcodes.serial

Interface PingMagicBytesAccessor.PingMagicBytesProperty

All Superinterfaces:

PingMagicBytesAccessor, PingMagicBytesAccessor.PingMagicBytesMutator

Enclosing interface:

PingMagicBytesAccessor

public static interface PingMagicBytesAccessor.PingMagicBytesProperty
extends PingMagicBytesAccessor, PingMagicBytesAccessor.PingMagicBytesMutator

Provides a ping magic bytes property.

Nested Class Summary

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

PingMagicBytesAccessor.PingMagicBytesBuilder<B extends PingMagicBytesAccessor.PingMagicBytesBuilder<B>>, PingMagicBytesAccessor.PingMagicBytesMutator, PingMagicBytesAccessor.PingMagicBytesProperty

Method Summary

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

Methods inherited from interface org.refcodes.serial.PingMagicBytesAccessor

getPingMagicBytes

Methods inherited from interface org.refcodes.serial.PingMagicBytesAccessor.PingMagicBytesMutator

setPingMagicBytes, setPingMagicBytes, setPingMagicBytes

Method Detail

letPingMagicBytes

default byte[] letPingMagicBytes(byte[] aPingMagicBytes)

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

Parameters:

aPingMagicBytes - The character to set (via PingMagicBytesAccessor.PingMagicBytesMutator.setPingMagicBytes(byte[])).

Returns:

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

letPingMagicBytes

default String letPingMagicBytes(String aPingMagicBytes)

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

Parameters:

aPingMagicBytes - The character to set (via PingMagicBytesAccessor.PingMagicBytesMutator.setPingMagicBytes(byte[])).

Returns:

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

letPingMagicBytes

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

Parameters:

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