org.openmuc.jrxtx

Class SerialPortBuilder

java.lang.Object

org.openmuc.jrxtx.SerialPortBuilder

public class SerialPortBuilder
extends java.lang.Object

Builder class for SerialPorts. Provides a convenient way to set the various fields of a SerialPort. Example:

 
 SerialPort port = newBuilder("/dev/ttyS0")
                   .setBaudRate(19200)
                   .setParity(Parity.EVEN)
                   .build();
 InputStream is = port.getInputStream();
 ..
 
 

Method Summary

Modifier and Type	Method and Description
SerialPort	build() Combine all of the options that have been set and return a new SerialPort object.
static java.lang.String[]	getSerialPortNames() Get the serial port names on the host system.
static SerialPortBuilder	newBuilder(java.lang.String portName) Constructs a new SerialPortBuilder with the default values.
SerialPortBuilder	setBaudRate(int baudRate) Set the baud rate for the serial port.
SerialPortBuilder	setDataBits(DataBits dataBits) Set the number of data bits transfered with the serial port.
SerialPortBuilder	setFlowControl(FlowControl flowControl) Set the flow control type.
SerialPortBuilder	setParity(Parity parity) Set the parity of the serial port.
SerialPortBuilder	setPortName(java.lang.String portName) Set the serial port name.
SerialPortBuilder	setStopBits(StopBits stopBits) Set the number of stop bits after each data bits.

Methods inherited from class java.lang.Object

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

Method Detail

getSerialPortNames

public static java.lang.String[] getSerialPortNames()

Get the serial port names on the host system.

Returns:

the serial ports names.

newBuilder

public static SerialPortBuilder newBuilder(java.lang.String portName)

Constructs a new SerialPortBuilder with the default values.

Parameters:

portName - the serial port name. E.g. on Unix systems: "/dev/ttyUSB0" and on Unix

Returns:

returns the new builder.

setPortName

public SerialPortBuilder setPortName(java.lang.String portName)

Set the serial port name.

Parameters:

portName - the serial port name e.g. "/dev/ttyUSB0"

Returns:

the serial port builder.

setBaudRate

public SerialPortBuilder setBaudRate(int baudRate)

Set the baud rate for the serial port. Values such as 9600 or 115200.

Parameters:

baudRate - the baud rate.

Returns:

the serial port builder.

See Also:

setBaudRate(int)

setDataBits

public SerialPortBuilder setDataBits(DataBits dataBits)

Set the number of data bits transfered with the serial port.

Parameters:

dataBits - the number of dataBits.

Returns:

the serial port builder.

See Also:

SerialPort.setDataBits(DataBits)

setParity

public SerialPortBuilder setParity(Parity parity)

Set the parity of the serial port.

Parameters:

parity - the parity.

Returns:

the serial port builder.

See Also:

SerialPort.setParity(Parity)

setStopBits

public SerialPortBuilder setStopBits(StopBits stopBits)

Set the number of stop bits after each data bits.

Parameters:

stopBits - the number of stop bits.

Returns:

the serial port builder.

See Also:

SerialPort.setStopBits(StopBits)

setFlowControl

public SerialPortBuilder setFlowControl(FlowControl flowControl)

Set the flow control type.

Parameters:

flowControl - the flow control.

Returns:

the serial port builder.

See Also:

SerialPort.setFlowControl(FlowControl)

build

public SerialPort build()
                 throws java.io.IOException

Combine all of the options that have been set and return a new SerialPort object.

Returns:

a new serial port object.

Throws:

java.io.IOException - if an I/O exception occurred while opening the serial port.