jdk.dio.atcmd

Class ATDeviceConfig

java.lang.Object

jdk.dio.atcmd.ATDeviceConfig

All Implemented Interfaces:

DeviceConfig<ATDevice>, DeviceConfig.HardwareAddressing

public class ATDeviceConfig
extends java.lang.Object
implements DeviceConfig<ATDevice>, DeviceConfig.HardwareAddressing

The ATDeviceConfig class encapsulates the hardware addressing information, and static and dynamic configuration parameters of an AT device.

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

An instance of ATDeviceConfig can be passed to the DeviceManager.open(DeviceConfig) or DeviceManager.open(Class, DeviceConfig) method to open the designated AT device with the specified configuration. A InvalidDeviceConfigException is thrown when attempting to open a device with an invalid or unsupported configuration.

See Also:

DeviceManager.open(DeviceConfig), DeviceManager.open(Class, DeviceConfig)

Nested Class Summary

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

DeviceConfig.HardwareAddressing

Field Summary

Fields inherited from interface jdk.dio.DeviceConfig

DEFAULT

Constructor Summary

Constructors

Constructor and Description
ATDeviceConfig(int controllerNumber, int channelNumber) Creates a new ATDeviceConfig with the specified hardware addressing information.
ATDeviceConfig(java.lang.String controllerName, int channelNumber) Creates a new ATDeviceConfig with the specified hardware addressing information.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Checks two ATDeviceConfig objects for equality.
int	getChannelNumber() Gets the configured 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 controller number.
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

Constructor Detail

ATDeviceConfig

public ATDeviceConfig(java.lang.String controllerName,
              int channelNumber)

Creates a new ATDeviceConfig with the specified hardware addressing information.

Parameters:

controllerName - the controller name (such as its device file name on UNIX systems).

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

Throws:

java.lang.IllegalArgumentException - if channelNumber is not in the defined range.

java.lang.NullPointerException - if controller name is null.

ATDeviceConfig

public ATDeviceConfig(int controllerNumber,
              int channelNumber)

Creates a new ATDeviceConfig with the specified hardware addressing information.

Parameters:

controllerNumber - the controller number (a positive or zero integer) or DeviceConfig.DEFAULT.

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

Throws:

java.lang.IllegalArgumentException - if channelNumber is not in the defined range.

Method Detail

getChannelNumber

public int getChannelNumber()

Gets the configured channel number.

Returns:

the channel number (a positive or zero integer); or DeviceConfig.DEFAULT.

getControllerNumber

public int getControllerNumber()

Gets the configured controller number.

Specified by:

getControllerNumber in interface DeviceConfig.HardwareAddressing

Returns:

the controller number (a positive or zero integer) or DeviceConfig.DEFAULT.

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 ATDeviceConfig 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 ATDeviceConfig and has the same hardware addressing information and configuration parameter values as this ATDeviceConfig object.