com.oracle.deviceaccess.watchdog

Class WatchdogTimerConfig

java.lang.Object

com.oracle.deviceaccess.watchdog.WatchdogTimerConfig

All Implemented Interfaces:

PeripheralConfig<WatchdogTimer>, PeripheralConfig.HardwareAddressing

public class WatchdogTimerConfig
extends java.lang.Object
implements PeripheralConfig<WatchdogTimer>, PeripheralConfig.HardwareAddressing

The WatchdogTimerConfig class encapsulates the hardware addressing information, and static and dynamic configuration parameters of a watchdog timer.

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 WatchdogTimerConfig can be passed to the PeripheralManager.open(PeripheralConfig) or PeripheralManager.open(Class, PeripheralConfig) method to open the designated watchdog timer 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
WatchdogTimerConfig(int deviceNumber, int timerNumber) Creates a new WatchdogTimerConfig with the specified hardware addressing information.
WatchdogTimerConfig(java.lang.String deviceName, int timerNumber) Creates a new WatchdogTimerConfig with the specified hardware addressing information.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Checks two WatchdogTimerConfig objects for equality.
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	getTimerNumber() Gets the configured timer 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

WatchdogTimerConfig

public WatchdogTimerConfig(java.lang.String deviceName,
                   int timerNumber)

Creates a new WatchdogTimerConfig with the specified hardware addressing information.

Parameters:

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

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

Throws:

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

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

WatchdogTimerConfig

public WatchdogTimerConfig(int deviceNumber,
                   int timerNumber)

Creates a new WatchdogTimerConfig with the specified hardware addressing information.

Parameters:

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

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

Throws:

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

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

Method Detail

getTimerNumber

public int getTimerNumber()

Gets the configured timer number.

Returns:

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