com.oracle.deviceaccess.uart

Class UARTConfig

java.lang.Object

com.oracle.deviceaccess.uart.UARTConfig

All Implemented Interfaces:

PeripheralConfig<UART>, PeripheralConfig.HardwareAddressing

public final class UARTConfig
extends java.lang.Object
implements PeripheralConfig<UART>, PeripheralConfig.HardwareAddressing

The UARTConfig class encapsulates the hardware addressing information, and static and dynamic configuration parameters of a UART.

Some hardware addressing parameter, and static and dynamic configuration parameters may be set to PeripheralConfig.DEFAULT. Whether such default settings are supported is platform- as well as peripheral driver-dependent.

An instance of UARTConfig can be passed to the PeripheralManager.open(PeripheralConfig) or PeripheralManager.open(Class, PeripheralConfig) method to open the designated UART with the specified configuration. A PeripheralConfigInvalidException is thrown when attempting to open a peripheral device with an invalid or unsupported configuration.

See Also:

PeripheralManager.open(PeripheralConfig), PeripheralManager.open(Class, PeripheralConfig)

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.deviceaccess.PeripheralConfig

PeripheralConfig.HardwareAddressing

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATABITS_5 5 data bit format.
static int	DATABITS_6 6 data bit format.
static int	DATABITS_7 7 data bit format.
static int	DATABITS_8 8 data bit format.
static int	DATABITS_9 9 data bit format.
static int	FLOWCONTROL_NONE Flow control off.
static int	FLOWCONTROL_RTSCTS_IN RTS/CTS (hardware) flow control on input.
static int	FLOWCONTROL_RTSCTS_OUT RTS/CTS (hardware) flow control on output.
static int	FLOWCONTROL_XONXOFF_IN XON/XOFF (software) flow control on input.
static int	FLOWCONTROL_XONXOFF_OUT XON/XOFF (software) flow control on output.
static int	PARITY_EVEN EVEN parity scheme.
static int	PARITY_MARK MARK parity scheme.
static int	PARITY_NONE No parity bit.
static int	PARITY_ODD ODD parity scheme.
static int	PARITY_SPACE SPACE parity scheme.
static int	STOPBITS_1 Number of STOP bits - 1.
static int	STOPBITS_1_5 Number of STOP bits - 1-1/2.
static int	STOPBITS_2 Number of STOP bits - 2.

Fields inherited from interface com.oracle.deviceaccess.PeripheralConfig

DEFAULT

Constructor Summary

Constructors

Constructor and Description
UARTConfig(int deviceNumber, int channelNumber, int baudRate, int dataBits, int parity, int stopBits, int flowcontrol) Creates a new UARTConfig with the specified hardware addressing information and configuration parameters.
UARTConfig(int deviceNumber, int channelNumber, int baudRate, int dataBits, int parity, int stopBits, int flowcontrol, int inputBufferSize, int outputBufferSize) Creates a new UARTConfig with the specified hardware addressing information and configuration parameters.
UARTConfig(java.lang.String deviceName, int channelNumber, int baudRate, int dataBits, int parity, int stopBits, int flowcontrol) Creates a new UARTConfig with the specified hardware addressing information and configuration parameters.
UARTConfig(java.lang.String deviceName, int channelNumber, int baudRate, int dataBits, int parity, int stopBits, int flowcontrol, int inputBufferSize, int outputBufferSize) Creates a new UARTConfig with the specified hardware addressing information and configuration parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Checks two UARTConfig objects for equality.
int	getBaudRate() Gets the configured default/initial speed in Bauds.
int	getChannelNumber() Gets the configured UART channel number.
int	getDataBits() Gets the configured default/initial number of bits per character.
java.lang.String	getDeviceName() Gets the configured device name (such as to its device file name on UNIX systems).
int	getDeviceNumber() Gets the configured UART device number.
int	getFlowControlMode() Gets the configured flow control mode.
int	getInputBufferSize() Gets the requested input buffer size.
int	getOutputBufferSize() Gets the requested output buffer size.
int	getParity() Gets the configured default/initial parity.
int	getStopBits() Gets the configured default/initial number of stop bits per character.
int	hashCode() Returns the hash code value for this object.

Methods inherited from class java.lang.Object

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

Field Detail

DATABITS_5

public static final int DATABITS_5

5 data bit format.

See Also:

Constant Field Values

DATABITS_6

public static final int DATABITS_6

6 data bit format.

See Also:

Constant Field Values

DATABITS_7

public static final int DATABITS_7

7 data bit format.

See Also:

Constant Field Values

DATABITS_8

public static final int DATABITS_8

8 data bit format.

See Also:

Constant Field Values

DATABITS_9

public static final int DATABITS_9

9 data bit format.

See Also:

Constant Field Values

FLOWCONTROL_NONE

public static final int FLOWCONTROL_NONE

Flow control off.

See Also:

Constant Field Values

FLOWCONTROL_RTSCTS_IN

public static final int FLOWCONTROL_RTSCTS_IN

RTS/CTS (hardware) flow control on input.

This bit flag can be bitwise-combined (OR) with other flow control bit flags.

See Also:

Constant Field Values

FLOWCONTROL_RTSCTS_OUT

public static final int FLOWCONTROL_RTSCTS_OUT

RTS/CTS (hardware) flow control on output.

This bit flag can be bitwise-combined (OR) with other flow control bit flags.

See Also:

Constant Field Values

FLOWCONTROL_XONXOFF_IN

public static final int FLOWCONTROL_XONXOFF_IN

XON/XOFF (software) flow control on input.

This bit flag can be bitwise-combined (OR) with other flow control bit flags.

See Also:

Constant Field Values

FLOWCONTROL_XONXOFF_OUT

public static final int FLOWCONTROL_XONXOFF_OUT

XON/XOFF (software) flow control on output.

This bit flag can be bitwise-combined (OR) with other flow control bit flags.

See Also:

Constant Field Values

PARITY_EVEN

public static final int PARITY_EVEN

EVEN parity scheme.

See Also:

Constant Field Values

PARITY_MARK

public static final int PARITY_MARK

MARK parity scheme.

See Also:

Constant Field Values

PARITY_NONE

public static final int PARITY_NONE

No parity bit.

See Also:

Constant Field Values

PARITY_ODD

public static final int PARITY_ODD

ODD parity scheme.

See Also:

Constant Field Values

PARITY_SPACE

public static final int PARITY_SPACE

SPACE parity scheme.

See Also:

Constant Field Values

STOPBITS_1

public static final int STOPBITS_1

Number of STOP bits - 1.

See Also:

Constant Field Values

STOPBITS_1_5

public static final int STOPBITS_1_5

Number of STOP bits - 1-1/2.

See Also:

Constant Field Values

STOPBITS_2

public static final int STOPBITS_2

Number of STOP bits - 2.

See Also:

Constant Field Values

Constructor Detail

UARTConfig

public UARTConfig(int deviceNumber,
          int channelNumber,
          int baudRate,
          int dataBits,
          int parity,
          int stopBits,
          int flowcontrol)

Creates a new UARTConfig with the specified hardware addressing information and configuration parameters.

Parameters:

deviceNumber - the hardware UART controller's number (a positive or zero integer) or PeripheralConfig.DEFAULT.

channelNumber - the hardware UART channel's number (a positive or zero integer) or PeripheralConfig.DEFAULT.

baudRate - the speed in Bauds of the UART (a positive integer).

dataBits - the number of bits per character, one of: DATABITS_5, DATABITS_6, DATABITS_7, DATABITS_8 or DATABITS_9.

parity - the parity, one of: PARITY_ODD, PARITY_EVEN, PARITY_MARK, PARITY_SPACE, or PARITY_NONE.

stopBits - the number of stop bits per character, on of: STOPBITS_1, STOPBITS_1_5, or STOPBITS_2.

flowcontrol - the flow control mode - a bit-wise OR combination of FLOWCONTROL_NONE, FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN or FLOWCONTROL_XONXOFF_OUT.

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• deviceNumber is not in the defined range;
• channelNumber is not in the defined range;
• baudRate is not in the defined range;
• dataBits is not in the defined range;
• parity is not in the defined range;
• stopBits is not in the defined range;
• flowcontrol is not in the defined range.

UARTConfig

public UARTConfig(int deviceNumber,
          int channelNumber,
          int baudRate,
          int dataBits,
          int parity,
          int stopBits,
          int flowcontrol,
          int inputBufferSize,
          int outputBufferSize)

Creates a new UARTConfig with the specified hardware addressing information and configuration parameters. The platform/underlying driver may or may not allocate the requested sizes for the input and output buffers.

Parameters:

deviceNumber - the hardware UART controller's number (a positive or zero integer) or PeripheralConfig.DEFAULT.

channelNumber - the hardware UART channel's number (a positive or zero integer) or PeripheralConfig.DEFAULT.

baudRate - the speed in Bauds of the UART (a positive integer).

dataBits - the number of bits per character, one of: DATABITS_5, DATABITS_6, DATABITS_7, DATABITS_8 or DATABITS_9.

parity - the parity, one of: PARITY_ODD, PARITY_EVEN, PARITY_MARK, PARITY_SPACE, or PARITY_NONE.

stopBits - the number of stop bits per character, on of: STOPBITS_1, STOPBITS_1_5, or STOPBITS_2.

flowcontrol - the flow control mode - a bit-wise OR combination of FLOWCONTROL_NONE, FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN or FLOWCONTROL_XONXOFF_OUT.

inputBufferSize - the input buffer size (a positive or zero integer) or PeripheralConfig.DEFAULT - (advisory only).

outputBufferSize - the output buffer size (a positive or zero integer) or PeripheralConfig.DEFAULT - (advisory only).

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• deviceNumber is not in the defined range;
• channelNumber is not in the defined range;
• baudRate is not in the defined range;
• dataBits is not in the defined range;
• parity is not in the defined range;
• stopBits is not in the defined range;
• flowcontrol is not in the defined range;
• inputBufferSize is not in the defined range;
• outputBufferSize is not in the defined range.

UARTConfig

public UARTConfig(java.lang.String deviceName,
          int channelNumber,
          int baudRate,
          int dataBits,
          int parity,
          int stopBits,
          int flowcontrol)

Creates a new UARTConfig with the specified hardware addressing information and configuration parameters.

Parameters:

deviceName - the device name (such as to its device file name on UNIX systems).

channelNumber - the hardware UART channel's number (a positive or zero integer) or PeripheralConfig.DEFAULT.

baudRate - the speed in Bauds of the UART (a positive integer).

dataBits - the number of bits per character, one of: DATABITS_5, DATABITS_6, DATABITS_7, DATABITS_8 or DATABITS_9.

parity - the parity, one of: PARITY_ODD, PARITY_EVEN, PARITY_MARK, PARITY_SPACE, or PARITY_NONE.

stopBits - the number of stop bits per character, on of: STOPBITS_1, STOPBITS_1_5, or STOPBITS_2.

flowcontrol - the flow control mode - a bit-wise OR combination of FLOWCONTROL_NONE, FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN or FLOWCONTROL_XONXOFF_OUT.

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• channelNumber is not in the defined range;
• baudRate is not in the defined range;
• dataBits is not in the defined range;
• parity is not in the defined range;
• stopBits is not in the defined range;
• flowcontrol is not in the defined range.

java.lang.NullPointerException - if deviceName is null.

UARTConfig

public UARTConfig(java.lang.String deviceName,
          int channelNumber,
          int baudRate,
          int dataBits,
          int parity,
          int stopBits,
          int flowcontrol,
          int inputBufferSize,
          int outputBufferSize)

Creates a new UARTConfig with the specified hardware addressing information and configuration parameters. The platform/underlying driver may or may not allocate the requested sizes for the input and output buffers.

Parameters:

deviceName - the device name (such as to its device file name on UNIX systems).

channelNumber - the hardware UART channel's number (a positive or zero integer) or PeripheralConfig.DEFAULT.

baudRate - the speed in Bauds of the UART (a positive integer).

dataBits - the number of bits per character, one of: DATABITS_5, DATABITS_6, DATABITS_7, DATABITS_8 or DATABITS_9.

parity - the parity, one of: PARITY_ODD, PARITY_EVEN, PARITY_MARK, PARITY_SPACE, or PARITY_NONE.

stopBits - the number of stop bits per character, on of: STOPBITS_1, STOPBITS_1_5, or STOPBITS_2.

flowcontrol - the flow control mode - a bit-wise OR combination of FLOWCONTROL_NONE, FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN or FLOWCONTROL_XONXOFF_OUT.

inputBufferSize - the input buffer size (a positive or zero integer) or PeripheralConfig.DEFAULT - (advisory only).

outputBufferSize - the output buffer size (a positive or zero integer) or PeripheralConfig.DEFAULT - (advisory only).

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• channelNumber is not in the defined range;
• baudRate is not in the defined range;
• dataBits is not in the defined range;
• parity is not in the defined range;
• stopBits is not in the defined range;
• flowcontrol is not in the defined range;
• inputBufferSize is not in the defined range;
• outputBufferSize is not in the defined range.

java.lang.NullPointerException - if deviceName is null.

Method Detail

getBaudRate

public int getBaudRate()

Gets the configured default/initial speed in Bauds.

Returns:

the default/initial speed in Bauds of the UART (a positive integer).

getDataBits

public int getDataBits()

Gets the configured default/initial number of bits per character.

Returns:

the default/initial number of bits per character, one of: DATABITS_5, DATABITS_6, DATABITS_7, DATABITS_8 or DATABITS_9.

getFlowControlMode

public int getFlowControlMode()

Gets the configured flow control mode.

Returns:

the flow control mode - a bit-wise OR combination of FLOWCONTROL_NONE, FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN or FLOWCONTROL_XONXOFF_OUT.

getInputBufferSize

public int getInputBufferSize()

Gets the requested input buffer size. The platform/underlying driver may or may not allocate the requested size for the input buffer.

Returns:

the requested input buffer size (a positive or zero integer).

getOutputBufferSize

public int getOutputBufferSize()

Gets the requested output buffer size. The platform/underlying driver may or may not allocate the requested size for the output buffer.

Returns:

the requested output buffer size (a positive or zero integer).

getParity

public int getParity()

Gets the configured default/initial parity.

Returns:

the default/initial parity, one of: PARITY_ODD, PARITY_EVEN, PARITY_MARK, PARITY_SPACE, or PARITY_NONE.

getStopBits

public int getStopBits()

Gets the configured default/initial number of stop bits per character.

Returns:

the default/initial number of stop bits per character, on of: STOPBITS_1, STOPBITS_1_5, or STOPBITS_2.

getChannelNumber

public int getChannelNumber()

Gets the configured UART channel number.

Returns:

the hardware channel's number (a positive or zero integer) or PeripheralConfig.DEFAULT.

getDeviceNumber

public int getDeviceNumber()

Gets the configured UART device number.

Specified by:

getDeviceNumber in interface PeripheralConfig.HardwareAddressing

Returns:

the hardware controller's number (a positive or zero integer) or PeripheralConfig.DEFAULT.

getDeviceName

public java.lang.String getDeviceName()

Gets the configured device name (such as to its device file name on UNIX systems).

Specified by:

getDeviceName in interface PeripheralConfig.HardwareAddressing

Returns:

the device name or null.

hashCode

public int hashCode()

Returns the hash code value for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

equals

public boolean equals(java.lang.Object obj)

Checks two UARTConfig objects for equality.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to test for equality with this object.

Returns:

true if obj is a UARTConfig and has the same hardware addressing information and configuration parameter values as this UARTConfig object.