Module org.refcodes.serial

Package org.refcodes.serial

Class FullDuplexTxPortDecorator.Builder<PM extends PortMetrics>

java.lang.Object

org.refcodes.serial.FullDuplexTxPortDecorator.Builder<PM>

Type Parameters:

PM - The actual PortMetrics type to use.

Enclosing class:

FullDuplexTxPortDecorator<PM extends PortMetrics>

public static final class FullDuplexTxPortDecorator.Builder<PM extends PortMetrics>
extends Object

Builder for building a FullDuplexTxPortDecorator instance.

Method Summary

Modifier and Type	Method	Description
FullDuplexTxPortDecorator<PM>	build()	Builds the.
FullDuplexTxPortDecorator.Builder<PM>	withAcknowledgeMagicBytes(byte[] aAcknowledgeMagicBytes)	Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().
FullDuplexTxPortDecorator.Builder<PM>	withAcknowledgeRetryNumber(int aAcknowledgeRetryNumber)	Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().
FullDuplexTxPortDecorator.Builder<PM>	withAcknowledgeTimeoutInMs(long aAcknowledgeTimeoutInMs)	Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().
FullDuplexTxPortDecorator.Builder<PM>	withCrcAlgorithm(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)	Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().
FullDuplexTxPortDecorator.Builder<PM>	withCrcChecksumValidationMode(org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode)	Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().
FullDuplexTxPortDecorator.Builder<PM>	withEndianess(org.refcodes.numerical.Endianess aEndianess)	Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().
FullDuplexTxPortDecorator.Builder<PM>	withExecutorService(ExecutorService aExecutorService)	Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().
FullDuplexTxPortDecorator.Builder<PM>	withPort(Port<PM> aPort)	Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().
FullDuplexTxPortDecorator.Builder<PM>	withSequenceNumberInitValue(int aSequenceNumberInitValue)	Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().
FullDuplexTxPortDecorator.Builder<PM>	withSequenceNumberWidth(int aSequenceNumberWidth)	Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().
FullDuplexTxPortDecorator.Builder<PM>	withTransmissionMagicBytes(byte[] aTransmissionMagicBytes)	Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withEndianess

public FullDuplexTxPortDecorator.Builder<PM> withEndianess(org.refcodes.numerical.Endianess aEndianess)

Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().

Parameters:

aEndianess - The Endianess to use when calculating the CRC checksum.

Returns:

The FullDuplexTxPortDecorator.Builder to chain other operations as of the builder pattern.

withPort

public FullDuplexTxPortDecorator.Builder<PM> withPort(Port<PM> aPort)

Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().

Parameters:

aPort - the a port

Returns:

The FullDuplexTxPortDecorator.Builder to chain other operations as of the builder pattern.

withTransmissionMagicBytes

public FullDuplexTxPortDecorator.Builder<PM> withTransmissionMagicBytes(byte[] aTransmissionMagicBytes)

Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().

Parameters:

aTransmissionMagicBytes - The magic bytes identifying a regular transmission (as of FullDuplexTxPortDecorator.transmitSegment(Segment) or the like).

Returns:

The FullDuplexTxPortDecorator.Builder to chain other operations as of the builder pattern.

withAcknowledgeMagicBytes

public FullDuplexTxPortDecorator.Builder<PM> withAcknowledgeMagicBytes(byte[] aAcknowledgeMagicBytes)

Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().

Parameters:

aAcknowledgeMagicBytes - The ACK character to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

Returns:

The FullDuplexTxPortDecorator.Builder to chain other operations as of the builder pattern.

withAcknowledgeRetryNumber

public FullDuplexTxPortDecorator.Builder<PM> withAcknowledgeRetryNumber(int aAcknowledgeRetryNumber)

Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().

Parameters:

aAcknowledgeRetryNumber - The number of retries waiting for an ACK from the return channel.

Returns:

The FullDuplexTxPortDecorator.Builder to chain other operations as of the builder pattern.

withAcknowledgeTimeoutInMs

public FullDuplexTxPortDecorator.Builder<PM> withAcknowledgeTimeoutInMs(long aAcknowledgeTimeoutInMs)

Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().

Parameters:

aAcknowledgeTimeoutInMs - The timeout in milliseconds to pend till the next retry.

Returns:

The FullDuplexTxPortDecorator.Builder to chain other operations as of the builder pattern.

withSequenceNumberInitValue

public FullDuplexTxPortDecorator.Builder<PM> withSequenceNumberInitValue(int aSequenceNumberInitValue)

Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().

Parameters:

aSequenceNumberInitValue - The initialization value for the sequence number counter.

Returns:

The FullDuplexTxPortDecorator.Builder to chain other operations as of the builder pattern.

withSequenceNumberWidth

public FullDuplexTxPortDecorator.Builder<PM> withSequenceNumberWidth(int aSequenceNumberWidth)

Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().

Parameters:

aSequenceNumberWidth - The width in bytes to be used for the binary sequence number representation.

Returns:

The FullDuplexTxPortDecorator.Builder to chain other operations as of the builder pattern.

withCrcAlgorithm

public FullDuplexTxPortDecorator.Builder<PM> withCrcAlgorithm(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)

Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().

Parameters:

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

Returns:

The FullDuplexTxPortDecorator.Builder to chain other operations as of the builder pattern.

withCrcChecksumValidationMode

public FullDuplexTxPortDecorator.Builder<PM> withCrcChecksumValidationMode(org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode)

Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().

Parameters:

aCrcChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.

Returns:

The FullDuplexTxPortDecorator.Builder to chain other operations as of the builder pattern.

withExecutorService

public FullDuplexTxPortDecorator.Builder<PM> withExecutorService(ExecutorService aExecutorService)

Sets the according property for configuring the FullDuplexTxPortDecorator upon invoking build().

Parameters:

aExecutorService - The ExecutorService to be used when creating Thread instances for handling input and output data simultaneously.

Returns:

The FullDuplexTxPortDecorator.Builder to chain other operations as of the builder pattern.

build

public FullDuplexTxPortDecorator<PM> build()

Builds the.

Returns:

the full duplex segment multiplexer