UARTConfig (Device I/O API 1.1)

java.lang.Object
- jdk.dio.uart.UARTConfig

All Implemented Interfaces:

DeviceConfig<UART>, DeviceConfig.HardwareAddressing
```
public final class UARTConfig
extends java.lang.Object
implements DeviceConfig<UART>, DeviceConfig.HardwareAddressing
```
The UARTConfig class encapsulates the hardware addressing information, and static and dynamic configuration parameters of a UART.
Some hardware addressing, static or dynamic configuration parameters may be set to UNASSIGNED or null (see Unassigned, Default or Unused Parameter Values).
An instance of UARTConfig can be passed to the open(DeviceConfig, ...) and open(Class, DeviceConfig, ...) methods of the DeviceManager to open the designated UART with the specified configuration. A InvalidDeviceConfigException is thrown when attempting to open a device with an invalid or unsupported configuration.

Since:

1.0

See Also:
DeviceManager.open(DeviceConfig), DeviceManager.open(DeviceConfig, int), DeviceManager.open(Class, DeviceConfig), DeviceManager.open(Class, DeviceConfig, int)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UARTConfig.Builder
The Builder class allows for creating and initializing UARTConfig objects.
- Nested classes/interfaces inherited from interface jdk.dio.DeviceConfig
  DeviceConfig.HardwareAddressing

Nested Classes
Modifier and Type	Class and Description
`static class`	`UARTConfig.Builder` The `Builder` class allows for creating and initializing `UARTConfig` objects.

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 jdk.dio.DeviceConfig
DEFAULT, UNASSIGNED

Constructor Summary

Constructors
Constructor and Description
`UARTConfig(int controllerNumber, int channelNumber, int baudRate, int dataBits, int parity, int stopBits, int flowcontrol)` Deprecated. As of 1.1, use `UARTConfig.Builder` instead.
`UARTConfig(int controllerNumber, int channelNumber, int baudRate, int dataBits, int parity, int stopBits, int flowcontrol, int inputBufferSize, int outputBufferSize)` Deprecated. As of 1.1, use `UARTConfig.Builder` instead.
`UARTConfig(java.lang.String controllerName, int channelNumber, int baudRate, int dataBits, int parity, int stopBits, int flowcontrol)` Deprecated. As of 1.1, use `UARTConfig.Builder` instead.
`UARTConfig(java.lang.String controllerName, int channelNumber, int baudRate, int dataBits, int parity, int stopBits, int flowcontrol, int inputBufferSize, int outputBufferSize)` Deprecated. As of 1.1, use `UARTConfig.Builder` instead.

Method Summary

Methods
Modifier and Type	Method and Description
`static UARTConfig`	`deserialize(java.io.InputStream in)` Creates a new `UARTConfig` whose state is deserialized from the specified `InputStream`.
`boolean`	`equals(java.lang.Object obj)` Checks two `UARTConfig` objects for equality.
`int`	`getBaudRate()` Gets the configured initial speed in Bauds.
`int`	`getChannelNumber()` Gets the configured UART channel number.
`java.lang.String`	`getControllerName()` Gets the configured controller name (such as its device file name on UNIX systems).
`int`	`getControllerNumber()` Gets the configured UART controller number.
`int`	`getDataBits()` Gets the configured initial number of bits per character.
`int`	`getFlowControlMode()` Gets the configured initial flow control mode.
`int`	`getInputBufferSize()` Gets the requested or allocated input buffer size.
`int`	`getOutputBufferSize()` Gets the requested or allocated output buffer size.
`int`	`getParity()` Gets the configured initial parity.
`int`	`getStopBits()` Gets the configured initial number of stop bits per character.
`int`	`hashCode()` Returns the hash code value for this object.
`int`	`serialize(java.io.OutputStream out)` Serializes the state of this `UARTConfig` object to the specified `OutputStream`.

Methods inherited from class java.lang.Object
clone, 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 output 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 output 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 input flow control bit flags. The actual XON and XOFF characters used for software flow control are device hardware and driver-dependent.
    
    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 input flow control bit flags. The actual XON and XOFF characters used for software flow control are device hardware and driver-dependent.
    
    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
```
@Deprecated
public UARTConfig(int controllerNumber,
                     int channelNumber,
                     int baudRate,
                     int dataBits,
                     int parity,
                     int stopBits,
                     int flowcontrol)
```
    Deprecated. As of 1.1, use UARTConfig.Builder instead.
    
    Creates a new UARTConfig with the specified hardware addressing information and configuration parameters.
    The controller name is set to null. The requested input and output buffer sizes are set to UNASSIGNED.
    Parameters:
    controllerNumber - the hardware UART controller's number (a positive or zero integer) or UNASSIGNED.
    channelNumber - the hardware UART channel's number (a positive or zero integer) or UNASSIGNED.
    baudRate - the speed in Bauds (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: FLOWCONTROL_NONE if flow control is disabled; or a bit-wise OR combination of FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN or FLOWCONTROL_XONXOFF_OUT.
    
    Throws:
    java.lang.IllegalArgumentException - if any of the following is true:
    
    controllerNumber 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 or if more than one input or more than one output flow control mode is specified.
  - UARTConfig
```
@Deprecated
public UARTConfig(int controllerNumber,
                     int channelNumber,
                     int baudRate,
                     int dataBits,
                     int parity,
                     int stopBits,
                     int flowcontrol,
                     int inputBufferSize,
                     int outputBufferSize)
```
    Deprecated. As of 1.1, use UARTConfig.Builder instead.
    
    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.
    The controller name is set to null. The requested input and output buffer sizes are set to UNASSIGNED.
    Parameters:
    controllerNumber - the hardware UART controller's number (a positive or zero integer) or UNASSIGNED.
    channelNumber - the hardware UART channel's number (a positive or zero integer) or UNASSIGNED.
    baudRate - the speed in Bauds (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: FLOWCONTROL_NONE if flow control is disabled; or a bit-wise OR combination of FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN or FLOWCONTROL_XONXOFF_OUT.
    inputBufferSize - the input buffer size (a positive or zero integer) or UNASSIGNED - (advisory only).
    outputBufferSize - the output buffer size (a positive or zero integer) or UNASSIGNED - (advisory only).
    
    Throws:
    java.lang.IllegalArgumentException - if any of the following is true:
    
    controllerNumber 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 or if more than one input or more than one output flow control mode is specified.
    
    inputBufferSize is not in the defined range;
    
    outputBufferSize is not in the defined range.
  - UARTConfig
```
@Deprecated
public UARTConfig(java.lang.String controllerName,
                     int channelNumber,
                     int baudRate,
                     int dataBits,
                     int parity,
                     int stopBits,
                     int flowcontrol)
```
    Deprecated. As of 1.1, use UARTConfig.Builder instead.
    
    Creates a new UARTConfig with the specified hardware addressing information and configuration parameters.
    The controller number is set to UNASSIGNED. The requested input and output buffer sizes are set to UNASSIGNED.
    Parameters:
    controllerName - the controller name (such as its device file name on UNIX systems).
    channelNumber - the hardware UART channel's number (a positive or zero integer) or UNASSIGNED.
    baudRate - the speed in Bauds (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: FLOWCONTROL_NONE if flow control is disabled; or a bit-wise OR combination of 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 or if more than one input or more than one output flow control mode is specified.
    java.lang.NullPointerException - if controllerName is null.
  - UARTConfig
```
@Deprecated
public UARTConfig(java.lang.String controllerName,
                     int channelNumber,
                     int baudRate,
                     int dataBits,
                     int parity,
                     int stopBits,
                     int flowcontrol,
                     int inputBufferSize,
                     int outputBufferSize)
```
    Deprecated. As of 1.1, use UARTConfig.Builder instead.
    
    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.
    The controller number is set to UNASSIGNED. The requested input and output buffer sizes are set to UNASSIGNED.
    Parameters:
    controllerName - the controller name (such as its device file name on UNIX systems).
    channelNumber - the hardware UART channel's number (a positive or zero integer) or UNASSIGNED.
    baudRate - the speed in Bauds (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: FLOWCONTROL_NONE if flow control is disabled; or a bit-wise OR combination of FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN or FLOWCONTROL_XONXOFF_OUT.
    inputBufferSize - the input buffer size (a positive or zero integer) or UNASSIGNED - (advisory only).
    outputBufferSize - the output buffer size (a positive or zero integer) or UNASSIGNED - (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 or if more than one input or more than one output flow control mode is specified.
    
    inputBufferSize is not in the defined range;
    
    outputBufferSize is not in the defined range.
    java.lang.NullPointerException - if controllerName is null.
- Method Detail
  - deserialize
```
public static UARTConfig deserialize(java.io.InputStream in)
                              throws java.io.IOException
```
    Creates a new UARTConfig whose state is deserialized from the specified InputStream. This method may be invoked to restore the state of a UARTConfig object from a persistent store.
    
    Parameters:
    in - the stream to read from.
    
    Returns:
    a new UARTConfig instance.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs or if the provided stream does not contain a representation of a UARTConfig object.
    Since:
    
    1.1
  - serialize
```
public int serialize(java.io.OutputStream out)
              throws java.io.IOException
```
    Serializes the state of this UARTConfig object to the specified OutputStream. This method may be invoked by the DeviceManager to save the state of this UARTConfig object to a persistent store.
    
    Specified by:
    
    serialize in interface DeviceConfig<UART>
    
    Parameters:
    out - the stream to write to.
    
    Returns:
    the number of bytes written to the stream.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
    Since:
    
    1.1
    
    See Also:
    DeviceProvider.deserialize(java.io.InputStream)
  - getBaudRate
```
public int getBaudRate()
```
    Gets the configured initial speed in Bauds.
    
    Returns:
    the initial speed in Bauds (a positive integer).
  - getDataBits
```
public int getDataBits()
```
    Gets the configured initial number of bits per character.
    
    Returns:
    the 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 initial flow control mode.
    
    Returns:
    the flow control mode: FLOWCONTROL_NONE if flow control is disabled; or a valid bit-wise OR combination of FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN or FLOWCONTROL_XONXOFF_OUT.
  - getInputBufferSize
```
public int getInputBufferSize()
```
    Gets the requested or allocated input buffer size. The platform/underlying driver may or may not allocate the requested size for the input buffer. When querying the configuration of an opened or registered device the allocated buffer size is returned.
    
    Returns:
    the requested or allocated input buffer size (a positive or zero integer) or UNASSIGNED.
  - getOutputBufferSize
```
public int getOutputBufferSize()
```
    Gets the requested or allocated output buffer size. The platform/underlying driver may or may not allocate the requested size for the output buffer. When querying the configuration of an opened or registered device the allocated buffer size is returned.
    
    Returns:
    the requested or allocated output buffer size (a positive or zero integer) or UNASSIGNED.
  - getParity
```
public int getParity()
```
    Gets the configured initial parity.
    
    Returns:
    the initial parity, one of: PARITY_ODD, PARITY_EVEN, PARITY_MARK, PARITY_SPACE, or PARITY_NONE.
  - getStopBits
```
public int getStopBits()
```
    Gets the configured initial number of stop bits per character.
    
    Returns:
    the 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 UNASSIGNED.
  - getControllerNumber
```
public int getControllerNumber()
```
    Gets the configured UART controller number.
    
    Specified by:
    
    getControllerNumber in interface DeviceConfig.HardwareAddressing
    
    Returns:
    the hardware controller's number (a positive or zero integer) or UNASSIGNED.
  - getControllerName
```
public java.lang.String getControllerName()
```
    Gets the configured controller name (such as its device file name on UNIX systems).
    
    Specified by:
    
    getControllerName in interface DeviceConfig.HardwareAddressing
    
    Returns:
    the controller 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; false otherwise.

Class UARTConfig

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.dio.DeviceConfig

Field Summary

Fields inherited from interface jdk.dio.DeviceConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATABITS_5

DATABITS_6

DATABITS_7

DATABITS_8

DATABITS_9

FLOWCONTROL_NONE

FLOWCONTROL_RTSCTS_IN

FLOWCONTROL_RTSCTS_OUT

FLOWCONTROL_XONXOFF_IN

FLOWCONTROL_XONXOFF_OUT

PARITY_EVEN

PARITY_MARK

PARITY_NONE

PARITY_ODD

PARITY_SPACE

STOPBITS_1

STOPBITS_1_5

STOPBITS_2

Constructor Detail

UARTConfig

UARTConfig

UARTConfig

UARTConfig

Method Detail

deserialize

serialize

getBaudRate

getDataBits

getFlowControlMode

getInputBufferSize

getOutputBufferSize

getParity

getStopBits

getChannelNumber

getControllerNumber

getControllerName

hashCode

equals