com.oracle.deviceaccess.atcmd

Class ATDeviceConfig

java.lang.Object

com.oracle.deviceaccess.atcmd.ATDeviceConfig

All Implemented Interfaces:

PeripheralConfig<ATDevice>, PeripheralConfig.HardwareAddressing

public class ATDeviceConfig
extends java.lang.Object
implements PeripheralConfig<ATDevice>, PeripheralConfig.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 PeripheralConfig.DEFAULT. Whether such default settings are supported is platform- as well as peripheral driver-dependent.

An instance of ATDeviceConfig can be passed to the PeripheralManager.open(PeripheralConfig) or PeripheralManager.open(Class, PeripheralConfig) method to open the designated AT device 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 inherited from interface com.oracle.deviceaccess.PeripheralConfig

DEFAULT

Constructor Summary

Constructors

Constructor and Description
ATDeviceConfig(int deviceNumber, int channelNumber) Creates a new ATDeviceConfig with the specified hardware addressing information.
ATDeviceConfig(java.lang.String deviceName, 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	getDeviceName() Gets the configured device name (such as to its device file name on UNIX systems).
int	getDeviceNumber() Gets the configured device 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 deviceName,
              int channelNumber)

Creates a new ATDeviceConfig with the specified hardware addressing information.

Parameters:

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

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

Throws:

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

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

ATDeviceConfig

public ATDeviceConfig(int deviceNumber,
              int channelNumber)

Creates a new ATDeviceConfig with the specified hardware addressing information.

Parameters:

deviceNumber - the device number (a positive or zero integer) or PeripheralConfig.DEFAULT.

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

Throws:

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

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

Method Detail

getChannelNumber

public int getChannelNumber()

Gets the configured channel number.

Returns:

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

getDeviceNumber

public int getDeviceNumber()

Gets the configured device number.

Specified by:

getDeviceNumber in interface PeripheralConfig.HardwareAddressing

Returns:

the device 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 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.