jdk.dio.atcmd

Class ATDeviceConfig

java.lang.Object

jdk.dio.atcmd.ATDeviceConfig

All Implemented Interfaces:

DeviceConfig<ATDevice>, DeviceConfig.HardwareAddressing

public final 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, static or dynamic configuration parameters may be set to UNASSIGNED or null (see Unassigned, Default or Unused Parameter Values).

An instance of ATDeviceConfig can be passed to the open(DeviceConfig, ...) and open(Class, DeviceConfig, ...) methods of the DeviceManager 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.

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/interfaces inherited from interface jdk.dio.DeviceConfig

DeviceConfig.HardwareAddressing

Field Summary

Fields inherited from interface jdk.dio.DeviceConfig

DEFAULT, UNASSIGNED

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
static ATDeviceConfig	deserialize(java.io.InputStream in) Creates a new ATDeviceConfig whose state is deserialized from the specified InputStream.
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.
int	serialize(java.io.OutputStream out) Serializes the state of this ATDeviceConfig object to the specified OutputStream.

Methods inherited from class java.lang.Object

clone, 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.

The controller number is set to UNASSIGNED.

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 UNASSIGNED.

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.

The controller name is set to null.

Parameters:

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

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

Throws:

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

Method Detail

deserialize

public static ATDeviceConfig deserialize(java.io.InputStream in)
                                  throws java.io.IOException

Creates a new ATDeviceConfig whose state is deserialized from the specified InputStream. This method may be invoked to restore the state of a ATDeviceConfig object from a persistent store.

Parameters:

in - the stream to read from.

Returns:

a new ATDeviceConfig instance.

Throws:

java.io.IOException - if an I/O error occurs or if the provided stream does not contain a representation of a ATDeviceConfig object.

Since:

1.1

serialize

public int serialize(java.io.OutputStream out)
              throws java.io.IOException

Serializes the state of this ATDeviceConfig object to the specified OutputStream. This method may be invoked by the DeviceManager to save the state of this ATDeviceConfig object to a persistent store.

Specified by:

serialize in interface DeviceConfig<ATDevice>

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)

getChannelNumber

public int getChannelNumber()

Gets the configured channel number.

Returns:

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

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 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 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; false otherwise.