javax.microedition.power

Class PowerManagerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

javax.microedition.power.PowerManagerException

public class PowerManagerException
extends java.lang.RuntimeException

Thrown when a power management related error is encountered. Different errors can be identified by the error code. Method getErrCode can be used to retrieve the error that causes the exception.

Error code ILLEGAL_STATE_TRANSITION_REQUEST, STATE_TRANSITION_FAILURE, must be used by the subclass of PowerManager to indicate power state related errors.

Error code KEEP_CURRENT_STATE should be used by the EventListener when the listener wants to oppose the current state change event:

public class MyApplication extends MIDlet implements EventListener { // ... void handleEvent(Event ev) { if((ev instanceof PowerStateEvent) && // some condition that I do not like a certain change // of the power state right now // ... && (!(((PowerStateEvent)ev).isUrgent()))) { throw new PowerStateException( KEEP_CURRENT_STATE, "some objective"); } } // ... }

Field Summary

Fields

Modifier and Type	Field and Description
static byte	ILLEGAL_STATE_TRANSITION_REQUEST An illegal transition requested.
static byte	KEEP_CURRENT_STATE Transition did not change states.
static byte	STATE_TRANSITION_FAILURE State transition failed.

Constructor Summary

Constructors

Constructor and Description
PowerManagerException(byte err) Constructs a PowerManagerException object with an error code.
PowerManagerException(byte err, java.lang.String msg) Constructs an PowerManagerException object with an error code and a detailed message.

Method Summary

Methods

Modifier and Type	Method and Description
byte	getReason() Gets the exception error code.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getSuppressed, initCause, printStackTrace, printStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ILLEGAL_STATE_TRANSITION_REQUEST

public static final byte ILLEGAL_STATE_TRANSITION_REQUEST

An illegal transition requested.

See Also:

Constant Field Values

KEEP_CURRENT_STATE

public static final byte KEEP_CURRENT_STATE

Transition did not change states.

See Also:

Constant Field Values

STATE_TRANSITION_FAILURE

public static final byte STATE_TRANSITION_FAILURE

State transition failed.

See Also:

Constant Field Values

Constructor Detail

PowerManagerException

public PowerManagerException(byte err)

Constructs a PowerManagerException object with an error code.

Parameters:

err - the error code that is used to create the exception object. MUST be one of ILLEGAL_STATE_TRANSITION_REQUEST, KEEP_CURRENT_STATE, or STATE_TRANSITION_FAILURE.

Throws:

java.lang.IllegalArgumentException - thrown for an unrecognized error code.

PowerManagerException

public PowerManagerException(byte err,
                     java.lang.String msg)

Constructs an PowerManagerException object with an error code and a detailed message.

Parameters:

err - the error code that is used to create the exception object. MUST be one of ILLEGAL_STATE_TRANSITION_REQUEST, KEEP_CURRENT_STATE, or STATE_TRANSITION_FAILURE.

msg - the detailed message

Throws:

java.lang.IllegalArgumentException - thrown for an unrecognized error code.

Method Detail

getReason

public byte getReason()

Gets the exception error code.

Returns:

the error code that is used to construct the exception object, MUST be one of ILLEGAL_STATE_TRANSITION_REQUEST, KEEP_CURRENT_STATE, or STATE_TRANSITION_FAILURE.