CardException (Java Card API, Classic Edition)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - javacard.framework.CardException

Direct Known Subclasses:

UserException
```
public class CardException
extends Exception
```
The CardException 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 checked Exception classes should extend CardException. 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

Constructors
Constructor Description

CardException(short reason)
Construct a CardException instance with the specified reason.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`short`	`getReason()`	Get reason code
`void`	`setReason(short reason)`	Set reason code
`static void`	`throwIt(short reason)`	Throw the Java Card runtime environment-owned instance of `CardException` class with the specified reason.

Methods inherited from class java.lang.Object
equals

- Constructor Detail
  - CardException
```
public CardException(short reason)
```
    Construct a CardException instance with the specified reason. To conserve on resources, use the throwIt() method to use the Java Card runtime environment-owned instance of this class.
    
    Parameters:
    
    reason - the reason for the exception
- Method Detail
  - getReason
```
public short getReason()
```
    Get reason code
    
    Returns:
    
    the reason for the exception
  - setReason
```
public void setReason(short reason)
```
    Set reason code
    
    Parameters:
    
    reason - the reason for the exception
  - throwIt
```
public static void throwIt(short reason)
                    throws CardException
```
    Throw the Java Card runtime environment-owned instance of CardException 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, Java Card Platform, Classic Edition, section 6.2.1 for details.
    
    Parameters:
    
    reason - the reason for the exception
    
    Throws:
    
    CardException - always