com.oracle.deviceaccess.generic

Class GenericDeviceConfig

java.lang.Object

com.oracle.deviceaccess.generic.GenericDeviceConfig

All Implemented Interfaces:

PeripheralConfig<GenericDevice>, PeripheralConfig.HardwareAddressing

public final class GenericDeviceConfig
extends java.lang.Object
implements PeripheralConfig<GenericDevice>, PeripheralConfig.HardwareAddressing

The GenericDeviceConfig class encapsulates the hardware addressing information of generic device.

Note that it does not encapsulates static or dynamic configuration parameters; and that configuration parameters should be set using the GenericDevice.setControl method.

An instance of GenericDeviceConfig can be passed to the PeripheralManager.open(PeripheralConfig) or PeripheralManager.open(Class, PeripheralConfig) method to open the designated generic 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
GenericDeviceConfig(int deviceNumber, int channelNumber) Creates a new GenericDeviceConfig with the specified hardware addressing information .
GenericDeviceConfig(java.lang.String deviceName) Creates a new GenericDeviceConfig with the specified hardware addressing information.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Checks two GenericDeviceConfig 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

GenericDeviceConfig

public GenericDeviceConfig(int deviceNumber,
                   int channelNumber)

Creates a new GenericDeviceConfig with the specified hardware addressing information .

Parameters:

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

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

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.

GenericDeviceConfig

public GenericDeviceConfig(java.lang.String deviceName)

Creates a new GenericDeviceConfig with the specified hardware addressing information.

Parameters:

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

Throws:

java.lang.NullPointerException - if deviceName is null.

Method Detail

getChannelNumber

public int getChannelNumber()

Gets the configured channel number.

Returns:

the hardware device channel's 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 hardware device 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 GenericDeviceConfig 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 GenericDeviceConfig and has the same hardware addressing information and configuration parameter values as this GenericDeviceConfig object.