Module org.refcodes.serial.alt.tty

Package org.refcodes.serial.alt.tty

Class TtyPortMetrics

java.lang.Object

org.refcodes.serial.alt.tty.TtyPortMetrics

All Implemented Interfaces:

org.refcodes.mixin.ReadTimeoutInMsAccessor, org.refcodes.mixin.WriteTimeoutInMsAccessor, org.refcodes.serial.PortMetrics

public class TtyPortMetrics
extends Object
implements org.refcodes.serial.PortMetrics, org.refcodes.mixin.ReadTimeoutInMsAccessor, org.refcodes.mixin.WriteTimeoutInMsAccessor

The TtyPortMetrics describe a COM or TTY serial Port on your computer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TtyPortMetrics.Builder	Builder to build TtyPortMetrics.

Nested classes/interfaces inherited from interface org.refcodes.mixin.ReadTimeoutInMsAccessor

org.refcodes.mixin.ReadTimeoutInMsAccessor.ReadTimeoutInMsBuilder<B extends org.refcodes.mixin.ReadTimeoutInMsAccessor.ReadTimeoutInMsBuilder<B>>, org.refcodes.mixin.ReadTimeoutInMsAccessor.ReadTimeoutInMsMutator, org.refcodes.mixin.ReadTimeoutInMsAccessor.ReadTimeoutInMsProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.WriteTimeoutInMsAccessor

org.refcodes.mixin.WriteTimeoutInMsAccessor.WriteTimeoutInMsBuilder<B extends org.refcodes.mixin.WriteTimeoutInMsAccessor.WriteTimeoutInMsBuilder<B>>, org.refcodes.mixin.WriteTimeoutInMsAccessor.WriteTimeoutInMsMutator, org.refcodes.mixin.WriteTimeoutInMsAccessor.WriteTimeoutInMsProperty

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_DATA_BITS

Constructor Summary

Constructors

Constructor	Description
TtyPortMetrics()	Constructs the PortMetrics instance.
TtyPortMetrics(int aBaudRate)	Constructs the PortMetrics instance.
TtyPortMetrics(int aBaudRate, int aDataBits, StopBits aStopBits, Parity aParity)	Constructs the PortMetrics instance.
TtyPortMetrics(int aBaudRate, int aDataBits, StopBits aStopBits, Parity aParity, Handshake aHandshake)	Constructs the PortMetrics instance.
TtyPortMetrics(int aBaudRate, int aDataBits, StopBits aStopBits, Parity aParity, Handshake aHandshake, long aReadTimeoutInMs, long aWriteTimeoutInMs)	Constructs the PortMetrics instance.
TtyPortMetrics(BaudRate aBaudRate)	Constructs the PortMetrics instance.
TtyPortMetrics(BaudRate aBaudRate, int aDataBits, StopBits aStopBits, Parity aParity)	Constructs the PortMetrics instance.
TtyPortMetrics(BaudRate aBaudRate, int aDataBits, StopBits aStopBits, Parity aParity, Handshake aHandshake)	Constructs the PortMetrics instance.
TtyPortMetrics(BaudRate aBaudRate, int aDataBits, StopBits aStopBits, Parity aParity, Handshake aHandshake, long aReadTimeoutInMs, long aWriteTimeoutInMs)	Constructs the PortMetrics instance.

Method Summary

Modifier and Type	Method	Description
static TtyPortMetrics.Builder	builder()	Creates builder to build TtyPortMetrics.
int	getBaudRate()	The baud rate of the port.
int	getDataBits()	The number of data bits used by the port.
Handshake	getHandshake()	The kind of Handshake used by the port.
Parity	getParity()	The Parity of the port.
long	getReadTimeoutInMs()	The read timeout in milliseconds.
StopBits	getStopBits()	The number of stop bits used by the port.
long	getWriteTimeoutInMs()	The write timeout in milliseconds.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DATA_BITS

public static final int DEFAULT_DATA_BITS

See Also:

Constant Field Values

Constructor Detail

TtyPortMetrics

public TtyPortMetrics(int aBaudRate,
                      int aDataBits,
                      StopBits aStopBits,
                      Parity aParity,
                      Handshake aHandshake,
                      long aReadTimeoutInMs,
                      long aWriteTimeoutInMs)

Constructs the PortMetrics instance.

Parameters:

aBaudRate - The baud rate to be set.

aDataBits - The data bits to be set.

aStopBits - The StopBits to be set.

aParity - The Parity be set.

aHandshake - The Handshake be set.

aReadTimeoutInMs - The read timeout to be set.

aWriteTimeoutInMs - The write timeout to be set.

TtyPortMetrics

public TtyPortMetrics(BaudRate aBaudRate,
                      int aDataBits,
                      StopBits aStopBits,
                      Parity aParity,
                      Handshake aHandshake,
                      long aReadTimeoutInMs,
                      long aWriteTimeoutInMs)

Constructs the PortMetrics instance.

Parameters:

aBaudRate - The BaudRate to be set.

aDataBits - The data bits to be set.

aStopBits - The StopBits to be set.

aParity - The Parity be set.

aHandshake - The Handshake be set.

aReadTimeoutInMs - The read timeout to be set.

aWriteTimeoutInMs - The write timeout to be set.

TtyPortMetrics

public TtyPortMetrics(int aBaudRate,
                      int aDataBits,
                      StopBits aStopBits,
                      Parity aParity,
                      Handshake aHandshake)

Constructs the PortMetrics instance. Timeouts are disabled.

Parameters:

aBaudRate - The baud rate to be set.

aDataBits - The data bits to be set.

aStopBits - The StopBits to be set.

aParity - The Parity be set.

aHandshake - The Handshake be set.

TtyPortMetrics

public TtyPortMetrics(BaudRate aBaudRate,
                      int aDataBits,
                      StopBits aStopBits,
                      Parity aParity,
                      Handshake aHandshake)

Constructs the PortMetrics instance. Timeouts are disabled.

Parameters:

aBaudRate - The BaudRate to be set.

aDataBits - The data bits to be set.

aStopBits - The StopBits to be set.

aParity - The Parity be set.

aHandshake - The Handshake be set.

TtyPortMetrics

public TtyPortMetrics(int aBaudRate,
                      int aDataBits,
                      StopBits aStopBits,
                      Parity aParity)

Constructs the PortMetrics instance. Timeouts are disabled. The underlying system's implementation or other implementation specific handshaking is used (Handshake.AUTO).

Parameters:

aBaudRate - The baud rate to be set.

aDataBits - The data bits to be set.

aStopBits - The StopBits to be set.

aParity - The Parity be set.

TtyPortMetrics

public TtyPortMetrics(BaudRate aBaudRate,
                      int aDataBits,
                      StopBits aStopBits,
                      Parity aParity)

Constructs the PortMetrics instance. Timeouts are disabled. The underlying system's implementation or other implementation specific handshaking is used (Handshake.AUTO).

Parameters:

aBaudRate - The BaudRate to be set.

aDataBits - The data bits to be set.

aStopBits - The StopBits to be set.

aParity - The Parity be set.

TtyPortMetrics

public TtyPortMetrics(int aBaudRate)

Constructs the PortMetrics instance. Timeouts are disabled. The underlying system's implementation or other implementation specific handshaking, stop bits and parity are used (Handshake.AUTO).

Parameters:

aBaudRate - The baud rate to be set.

TtyPortMetrics

public TtyPortMetrics(BaudRate aBaudRate)

Constructs the PortMetrics instance. Timeouts are disabled. The underlying system's implementation or other implementation specific handshaking, stop bits and parity are used (Handshake.AUTO).

Parameters:

aBaudRate - The BaudRate to be set.

TtyPortMetrics

public TtyPortMetrics()

Constructs the PortMetrics instance. Timeouts are disabled. The underlying system's implementation or other implementation specific baud rate, handshaking, stop bits and parity are used (Handshake.AUTO).

Method Detail

getBaudRate

public int getBaudRate()

The baud rate of the port.

Returns:

The port's baud rate.

getParity

public Parity getParity()

The Parity of the port.

Returns:

The port's parity.

getDataBits

public int getDataBits()

The number of data bits used by the port.

Returns:

The data bits used by the port.

getStopBits

public StopBits getStopBits()

The number of stop bits used by the port.

Returns:

The stop bits used by the port.

getHandshake

public Handshake getHandshake()

The kind of Handshake used by the port.

Returns:

The port's handshake being used.

getReadTimeoutInMs

public long getReadTimeoutInMs()

The read timeout in milliseconds.

Specified by:

getReadTimeoutInMs in interface org.refcodes.mixin.ReadTimeoutInMsAccessor

Returns:

The read timeout.

getWriteTimeoutInMs

public long getWriteTimeoutInMs()

The write timeout in milliseconds.

Specified by:

getWriteTimeoutInMs in interface org.refcodes.mixin.WriteTimeoutInMsAccessor

Returns:

The write timeout.

toString

public String toString()

Overrides:

toString in class Object

builder

public static TtyPortMetrics.Builder builder()

Creates builder to build TtyPortMetrics.

Returns:

created builder