com.digi.android.serial

Class SerialPortParameters

java.lang.Object

com.digi.android.serial.SerialPortParameters

public final class SerialPortParameters
extends java.lang.Object

Helper class used to store serial connection parameters information.

Parameters are stored as public variables so that they can be accessed and read from any class.

Field Summary

Fields

Modifier and Type	Field and Description
int	baudRate
int	dataBits
int	flowControl
int	parity
int	readTimeout
int	stopBits

Constructor Summary

Constructors

Constructor and Description
SerialPortParameters(int baudRate, int dataBits, int stopBits, int parity, int flowControl, int readTimeout) Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

baudRate

public final int baudRate

dataBits

public final int dataBits

stopBits

public final int stopBits

parity

public final int parity

flowControl

public final int flowControl

readTimeout

public final int readTimeout

Constructor Detail

SerialPortParameters

public SerialPortParameters(int baudRate,
                    int dataBits,
                    int stopBits,
                    int parity,
                    int flowControl,
                    int readTimeout)

Class constructor. Instantiates a new SerialPortParameters object with the given parameters.

Parameters:

baudRate - Baud rate.

dataBits - Data bits, one of SerialPort.DATABITS_5, SerialPort.DATABITS_6, SerialPort.DATABITS_7, and SerialPort.DATABITS_8.

stopBits - Stop bits, one of SerialPort.STOPBITS_1, SerialPort.STOPBITS_2, and SerialPort.STOPBITS_1_5.

parity - Parity, one of SerialPort.PARITY_NONE, SerialPort.PARITY_ODD, SerialPort.PARITY_EVEN, SerialPort.PARITY_MARK, and SerialPort.PARITY_SPACE.

flowControl - Flow control, one of SerialPort.FLOWCONTROL_NONE, SerialPort.FLOWCONTROL_RTSCTS_IN, SerialPort.FLOWCONTROL_RTSCTS_OUT, SerialPort.FLOWCONTROL_XONXOFF_IN, and SerialPort.FLOWCONTROL_XONXOFF_OUT.

readTimeout - Serial connection read timeout.

Throws:

java.lang.IllegalArgumentException - If baudRate < 0 or if dataBits < 0 or if stopBits < 0 or if parity < 0 or if flowControl < 0 or if readTimeout < 0.

See Also:

SerialPort.DATABITS_5, SerialPort.DATABITS_6, SerialPort.DATABITS_7, SerialPort.DATABITS_8, SerialPort.FLOWCONTROL_NONE, SerialPort.FLOWCONTROL_RTSCTS_IN, SerialPort.FLOWCONTROL_RTSCTS_OUT, SerialPort.FLOWCONTROL_XONXOFF_IN, SerialPort.FLOWCONTROL_XONXOFF_OUT, SerialPort.PARITY_EVEN, SerialPort.PARITY_MARK, SerialPort.PARITY_NONE, SerialPort.PARITY_ODD, SerialPort.PARITY_SPACE, SerialPort.STOPBITS_1, SerialPort.STOPBITS_1_5, SerialPort.STOPBITS_2

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object