sim.toolkit
Class ToolkitException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.lang.RuntimeException
                    |
                    +--javacard.framework.CardRuntimeException
                          |
                          +--sim.toolkit.ToolkitException

public class ToolkitException
extends javacard.framework.CardRuntimeException

This class extends the Throwable class and allows the classes of this package to throw specific exceptions in case of problems.

Version:
5.1.0

Field Summary
static short ALLOWED_LENGTH_EXCEEDED
          This reason code (=10) is used to indicate that the provided menu entry string is bigger than the space alloacted space
static short BAD_INPUT_PARAMETER
          This reason code (=14) is used to indicate that an input parameter of the method is not valid
static short COMMAND_NOT_ALLOWED
          This reason code (=15) is used to indicate that the proactive command being sent is not allowed by the SIM Toolkit Framework.
static short EVENT_ALREADY_REGISTERED
          This reason code (= 7) is used to indicate that the maximum number of registered applet for this event is already reached (e.g Call Control)
static short EVENT_NOT_ALLOWED
          This reason code (=13) is used to indicate that the registration to an indicated event can not be changed by the called method.
static short EVENT_NOT_SUPPORTED
          This reason code (= 6) is used to indicate that the event code is not supported by the toolkit framework
static short HANDLER_NOT_AVAILABLE
          This reason code (= 2) is used to indicate that the Handler is not available (e.g.
static short HANDLER_OVERFLOW
          This reason code (= 1) is used to indicate that data are to large than the storage space available in the handler.
static short INVALID_TIMER_ID
          This reason code (=12) is used to indicate that the indicated timer identifier is not allocated to this applet.
static short ME_PROFILE_NOT_AVAILABLE
          This reason code (= 9) is used to indicate that the Terminal Profile data are not available
static short MENU_ENTRY_NOT_FOUND
          This reason code (= 4) is used to indicate that the requested menu entry is not define for the corresponding applet.
static short NO_TIMER_AVAILABLE
          This reason code (=11) is used to indicate that all the available timers or the maximum number of timers have been allocated to the applet
static short OUT_OF_TLV_BOUNDARIES
          This reason code (= 8) is used to indictae that either the offset, the length or both are out of current TLV boundaries
static short REGISTRY_ERROR
          This reason code (= 5) is used to indicate an error in the applet registry
static short TAR_NOT_DEFINED
          This reason code (=16) is used to indicate that there is no TAR defined for the applet.
static short UNAVAILABLE_ELEMENT
          This reason code (= 3) is used to indicate that the element is unavailable in the handler buffer.
 
Constructor Summary
ToolkitException(short reason)
          Construct a ToolkitException instance with the specified reason.
 
Method Summary
static void throwIt(short reason)
          Throws the JCRE instance of the ToolkitException class with the specified reason.
 
Methods inherited from class javacard.framework.CardRuntimeException
getReason, setReason
 
Methods inherited from class java.lang.Object
equals
 

Field Detail

HANDLER_OVERFLOW

public static final short HANDLER_OVERFLOW
This reason code (= 1) is used to indicate that data are to large than the storage space available in the handler.

HANDLER_NOT_AVAILABLE

public static final short HANDLER_NOT_AVAILABLE
This reason code (= 2) is used to indicate that the Handler is not available (e.g. busy).

UNAVAILABLE_ELEMENT

public static final short UNAVAILABLE_ELEMENT
This reason code (= 3) is used to indicate that the element is unavailable in the handler buffer.

MENU_ENTRY_NOT_FOUND

public static final short MENU_ENTRY_NOT_FOUND
This reason code (= 4) is used to indicate that the requested menu entry is not define for the corresponding applet.

REGISTRY_ERROR

public static final short REGISTRY_ERROR
This reason code (= 5) is used to indicate an error in the applet registry

EVENT_NOT_SUPPORTED

public static final short EVENT_NOT_SUPPORTED
This reason code (= 6) is used to indicate that the event code is not supported by the toolkit framework

EVENT_ALREADY_REGISTERED

public static final short EVENT_ALREADY_REGISTERED
This reason code (= 7) is used to indicate that the maximum number of registered applet for this event is already reached (e.g Call Control)

OUT_OF_TLV_BOUNDARIES

public static final short OUT_OF_TLV_BOUNDARIES
This reason code (= 8) is used to indictae that either the offset, the length or both are out of current TLV boundaries

ME_PROFILE_NOT_AVAILABLE

public static final short ME_PROFILE_NOT_AVAILABLE
This reason code (= 9) is used to indicate that the Terminal Profile data are not available

ALLOWED_LENGTH_EXCEEDED

public static final short ALLOWED_LENGTH_EXCEEDED
This reason code (=10) is used to indicate that the provided menu entry string is bigger than the space alloacted space

NO_TIMER_AVAILABLE

public static final short NO_TIMER_AVAILABLE
This reason code (=11) is used to indicate that all the available timers or the maximum number of timers have been allocated to the applet

INVALID_TIMER_ID

public static final short INVALID_TIMER_ID
This reason code (=12) is used to indicate that the indicated timer identifier is not allocated to this applet.

EVENT_NOT_ALLOWED

public static final short EVENT_NOT_ALLOWED
This reason code (=13) is used to indicate that the registration to an indicated event can not be changed by the called method.

BAD_INPUT_PARAMETER

public static final short BAD_INPUT_PARAMETER
This reason code (=14) is used to indicate that an input parameter of the method is not valid

COMMAND_NOT_ALLOWED

public static final short COMMAND_NOT_ALLOWED
This reason code (=15) is used to indicate that the proactive command being sent is not allowed by the SIM Toolkit Framework.

TAR_NOT_DEFINED

public static final short TAR_NOT_DEFINED
This reason code (=16) is used to indicate that there is no TAR defined for the applet.
Constructor Detail

ToolkitException

public ToolkitException(short reason)
Construct a ToolkitException instance with the specified reason. To conserve on resources use throwIt() method to re-use the JCRE instance of this class.
Parameters:
reason - the reason for the exception
Method Detail

throwIt

public static void throwIt(short reason)
                    throws ToolkitException
Throws the JCRE instance of the ToolkitException class with the specified reason.
Parameters:
reason - the reason for the exception.
Throws:
ToolkitException - always