Module org.refcodes.serial.alt.tty

Package org.refcodes.serial.alt.tty

Class TtyPortMetrics.Builder

java.lang.Object

org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

All Implemented Interfaces:

org.refcodes.mixin.ReadTimeoutMillisAccessor.ReadTimeoutMillisBuilder<TtyPortMetrics.Builder>, org.refcodes.mixin.WriteTimeoutMillisAccessor.WriteTimeoutMillisBuilder<TtyPortMetrics.Builder>

Enclosing class:

TtyPortMetrics

public static final class TtyPortMetrics.Builder
extends Object
implements org.refcodes.mixin.ReadTimeoutMillisAccessor.ReadTimeoutMillisBuilder<TtyPortMetrics.Builder>, org.refcodes.mixin.WriteTimeoutMillisAccessor.WriteTimeoutMillisBuilder<TtyPortMetrics.Builder>

Builder to build TtyPortMetrics.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	baudRate
protected int	dataBits
protected Handshake	handshake
protected Parity	parity
protected long	readTimeoutInMs
protected StopBits	stopBits
protected long	writeTimeoutInMs

Method Summary

Modifier and Type	Method	Description
TtyPortMetrics	build()	Builds the according TtyPortMetrics from this TtyPortMetrics.Builder.
TtyPortMetrics.Builder	withBaudRate(int aBaudRate)	The baud rate of the port.
TtyPortMetrics.Builder	withBaudRate(BaudRate aBaudRate)	The baud rate of the port.
TtyPortMetrics.Builder	withDataBits(int aDataBits)	The number of data bits used by the port.
TtyPortMetrics.Builder	withHandshake(Handshake aHandshake)	The kind of Handshake used by the port.
TtyPortMetrics.Builder	withParity(Parity aParity)	The Parity of the port.
TtyPortMetrics.Builder	withReadTimeoutMillis(long aReadTimeoutInMs)
TtyPortMetrics.Builder	withStopBits(StopBits aStopBits)	The number of stop bits used by the port.
TtyPortMetrics.Builder	withWriteTimeoutMillis(long aWriteTimeoutInMs)

Methods inherited from class java.lang.Object

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

Field Details

baudRate

protected int baudRate

parity

protected Parity parity

dataBits

protected int dataBits

stopBits

protected StopBits stopBits

handshake

protected Handshake handshake

readTimeoutInMs

protected long readTimeoutInMs

writeTimeoutInMs

protected long writeTimeoutInMs

Method Details

withBaudRate

public TtyPortMetrics.Builder withBaudRate(int aBaudRate)

The baud rate of the port.

Parameters:

aBaudRate - The port's baud rate.

Returns:

This TtyPortMetrics.Builder as of the builder pattern.

withBaudRate

public TtyPortMetrics.Builder withBaudRate(BaudRate aBaudRate)

The baud rate of the port.

Parameters:

aBaudRate - The port's baud rate.

Returns:

This TtyPortMetrics.Builder as of the builder pattern.

withParity

public TtyPortMetrics.Builder withParity(Parity aParity)

The Parity of the port.

Parameters:

aParity - The port's parity.

Returns:

This TtyPortMetrics.Builder as of the builder pattern.

withDataBits

public TtyPortMetrics.Builder withDataBits(int aDataBits)

The number of data bits used by the port.

Parameters:

aDataBits - The data bits used by the port.

Returns:

This TtyPortMetrics.Builder as of the builder pattern.

withStopBits

public TtyPortMetrics.Builder withStopBits(StopBits aStopBits)

The number of stop bits used by the port.

Parameters:

aStopBits - The stop bits used by the port.

Returns:

This TtyPortMetrics.Builder as of the builder pattern.

withHandshake

public TtyPortMetrics.Builder withHandshake(Handshake aHandshake)

The kind of Handshake used by the port.

Parameters:

aHandshake - The port's handshake being used.

Returns:

This TtyPortMetrics.Builder as of the builder pattern.

withReadTimeoutMillis

public TtyPortMetrics.Builder withReadTimeoutMillis(long aReadTimeoutInMs)

Specified by:

withReadTimeoutMillis in interface org.refcodes.mixin.ReadTimeoutMillisAccessor.ReadTimeoutMillisBuilder<TtyPortMetrics.Builder>

withWriteTimeoutMillis

public TtyPortMetrics.Builder withWriteTimeoutMillis(long aWriteTimeoutInMs)

Specified by:

withWriteTimeoutMillis in interface org.refcodes.mixin.WriteTimeoutMillisAccessor.WriteTimeoutMillisBuilder<TtyPortMetrics.Builder>

build

public TtyPortMetrics build()

Builds the according TtyPortMetrics from this TtyPortMetrics.Builder.

Returns:

The accordingly configured TtyPortMetrics.