javacard.framework
Class CardException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by javacard.framework.CardException
Direct Known Subclasses:
UserException

@TransactionType(value=NOT_SUPPORTED)
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.

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

Direct instances of this exception class are not bound to any context and can be passed between contexts without any restrictions. Objects created and returned by the methods of this class are owned by the caller. In particular, a call to the Throwable.toString() returns a String instance bound to the owner context of the caller.

See Runtime Environment Specification for the Java Card Platform, Connected Edition, chapter 7 for details regarding transfer of ownership.


Constructor Summary
CardException(short reason)
          Construct a CardException instance with the specified reason.
 
Method Summary
 short getReason()
          Get reason code
 void setReason(short reason)
          Deprecated. Deprecated for extended applets and web applications on the Connected Edition of the Java Card 3 Platform. Create a new exception instead.
static void throwIt(short reason)
          Deprecated. Deprecated for extended applets and web applications on the Connected Edition of the Java Card 3 Platform. Throw a new exception instead.
 
Methods inherited from class java.lang.Throwable
getMessage, printStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CardException

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

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)
Deprecated. Deprecated for extended applets and web applications on the Connected Edition of the Java Card 3 Platform. Create a new exception instead.

Set reason code

Parameters:
reason - the reason for the exception

throwIt

public static void throwIt(short reason)
                    throws CardException
Deprecated. Deprecated for extended applets and web applications on the Connected Edition of the Java Card 3 Platform. Throw a new exception instead.

Throws a new instance of CardException class with the specified reason.

Note that a new instance is thrown upon each call to this method.

This method is for backward compatibility with Java Card 2.x and for interoperability of classic applet applications with the Java Card 3 Classic edition.

Parameters:
reason - the reason for the exception
Throws:
CardException - always


Copyright (c) 2009 Sun Microsystems, Inc. All rights reserved.