javacard.framework.UserException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jcardsim Show documentation

jCardSim is open-source library contains implementation of Java Card API

There is a newer version: 2.2.2

/*
 * Copyright 2011 Licel LLC.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package javacard.framework;

/**
 * UserException represents a User exception.
 * This class also provides a resource-saving mechanism (the throwIt() method) for user
 * exceptions by using a Java Card runtime environment-owned instance.
 * 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.
 */
public class UserException extends CardException {

    /**
     * Constructs a UserException with reason = 0.
     * To conserve on resources use throwIt()
     * to use the Java Card runtime environment-owned instance of this class.
     */
    public UserException() {
        this((short) 0);
    }

    /**
     * Constructs a UserException with the specified reason.
     * To conserve on resources use throwIt()
     * to use the Java Card runtime environment-owned instance of this class.
     * @param reason the reason for the exception
     */
    public UserException(short reason) {
        super(reason);
    }

    /**
     * Throws the Java Card runtime environment-owned instance of UserException 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.
     * @param reason the reason for the exception
     * @throws UserException always
     */
    public static void throwIt(short reason)
            throws UserException {
        throw new UserException(reason);
    }
}