**javacard.framework** 
 ====Class CardException  ====
  *[[javacard:java-card-api:object|java.lang.Object]] \\ 
    *[[javacard:java-card-api:throwable|java.lang.Throwable]] \\ 
      *[[javacard:java-card-api:exception|java.lang.Exception]] \\ 


**Direct Known Subclasses:** [[javacard:java-card-api:UserException|UserException]]  
 



 ----

public class **CardException**extends [[javacard:java-card-api:Exception|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 ^^ 
| **[[javacard:java-card-api:CardException#CardException(short)|CardException]] **(short reason)          Construct a CardException instance with the specified reason. |

 




^ Method Summary ^^ 
| ** short** | **[[javacard:java-card-api:CardException#getReason()|getReason]] **()          Get reason code |
| ** void** | **[[javacard:java-card-api:CardException#setReason(short)|setReason]] **(short reason)          Set reason code |
| **static void** | **[[javacard:java-card-api:CardException#throwIt(short)|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 ^ 
| [[javacard:java-card-api:Object#equals(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 [[javacard:java-card-api:CardException|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 for the Java Card Platform//, section 6.2.1 for details.

 
 

**Parameters:**reason - the reason for the exception
 
 
**Throws:**
[[javacard:java-card-api:CardException|CardException]]  - always