Overview | Package | Class | Use | Tree | Deprecated | Index | Help

Java Card
v2.2.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javacard.framework
Class CardRuntimeException

    java.lang.Object
      java.lang.Throwable
          java.lang.Exception
              java.lang.RuntimeException
                  javacard.framework.CardRuntimeException

Direct Known Subclasses:
  APDUException, BioException, CryptoException, ExternalException, ISOException, PINException, ServiceException, SystemException, TLVException, TransactionException, UtilException

    public class CardRuntimeException

extends RuntimeException

The `CardRuntimeException` class defines a field `reason` and two accessor methods `getReason()` and `setReason()`. The `reason` field encapsulates an exception cause identifier in the Java Card platform. All Java Card platform unchecked Exception classes should extend `CardRuntimeException`. This class also provides a resource-saving mechanism (`throwIt()` method) for using a Java Card runtime environment-owned instance of this class.

Even if a transaction is in progress, the update of the internal `reason` field shall not participate in the transaction. The value of the internal `reason` field of Java Card runtime environment-owned instance is reset to 0 on a tear or reset.

Constructor Summary
`CardRuntimeException(short reason)` Constructs a CardRuntimeException instance with the specified reason.

Method Summary
`short` | `getReason()` Gets the reason code
`void` | `setReason(short reason)` Sets the reason code.
`static void` | `throwIt(short reason)` Throws the Java Card runtime environment-owned instance of the `CardRuntimeException` class with the specified reason.

Methods inherited from class java.lang.Object
`equals`

Constructor Detail

### CardRuntimeException

    public CardRuntimeException(short reason)

  Constructs a CardRuntimeException instance with the specified reason. To conserve on resources, use the `throwIt()` method to employ the Java Card runtime environment-owned instance of this class.

  Parameters:
    `reason` - the reason for the exception

Method Detail

### getReason

    public short getReason()

  Gets the reason code

  Returns:
    the reason for the exception

### setReason

    public void setReason(short reason)

  Sets the reason code. Even if a transaction is in progress, the update of the internal `reason` field shall not participate in the transaction.

  Parameters:
    `reason` - the reason for the exception

### throwIt

    public static void throwIt(short reason)
                        throws CardRuntimeException

  Throws the Java Card runtime environment-owned instance of the `CardRuntimeException` class with the specified reason.

  Java Card runtime environment-owned instances of exception classes are temporary Java Card runtime environment Entry Point Objects and can be accessed from any applet context. References to these temporary objects cannot be stored in class variables or instance variables or array components. See Runtime Environment Specification for the Java Card Platform, section 6.2.1 for details.

  Parameters:
    `reason` - the reason for the exception
  Throws:
    `CardRuntimeException` - always

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

Java Card
v2.2.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1993-2005 Sun Microsystems, Inc. 4150 Network Circle,
Santa Clara, CA, 95054, U.S.A. All Rights Reserved.