Class BioException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

javacard.framework.CardRuntimeException

javacardx.biometry.BioException

public class BioException
extends CardRuntimeException

The BioException class encapsulates specific exceptions which can be thrown by the methods of the javacardx.biometry package in case of error.

Since:

2.2.2

Field Summary

Fields

Modifier and Type	Field	Description
static final short	ILLEGAL_USE	This reason code is used to indicate that the method should not be invoked based on the current state of the card.
static final short	ILLEGAL_VALUE	This reason code is used to indicate that one or more input parameters is out of allowed bounds.
static final short	INVALID_DATA	This reason code is used to indicate that the data the system encountered is illegible.
static final short	NO_SUCH_BIO_TEMPLATE	This reason code is used to indicate that the provided bio template type is not supported by the template builder.
static final short	NO_TEMPLATES_ENROLLED	This reason code is used to indicate that no reference template is available for matching, or that the reference template is uninitialized.

Constructor Summary

Constructors

Constructor	Description
BioException(short reason)	Construct a new biometric exception using a provided reason code.

Method Summary

Modifier and Type	Method	Description
static void	throwIt(short reason)	Throws the Java Card runtime environment owned instance of BioException with the specified reason.

Methods inherited from class CardRuntimeException

getReason, setReason

Modifier and Type	Method	Description
short	getReason()	Gets the reason code
void	setReason(short reason)	Sets the reason code.

Methods inherited from class Object

equals

Modifier and Type	Method	Description
boolean	equals(Object obj)	Compares two Objects for equality.

Field Details

ILLEGAL_VALUE

public static final short ILLEGAL_VALUE

This reason code is used to indicate that one or more input parameters is out of allowed bounds.

See Also:

• Constant Field Values

INVALID_DATA

public static final short INVALID_DATA

This reason code is used to indicate that the data the system encountered is illegible.

See Also:

• Constant Field Values

NO_SUCH_BIO_TEMPLATE

public static final short NO_SUCH_BIO_TEMPLATE

This reason code is used to indicate that the provided bio template type is not supported by the template builder.

See Also:

• Constant Field Values

NO_TEMPLATES_ENROLLED

public static final short NO_TEMPLATES_ENROLLED

This reason code is used to indicate that no reference template is available for matching, or that the reference template is uninitialized.

See Also:

• Constant Field Values

ILLEGAL_USE

public static final short ILLEGAL_USE

This reason code is used to indicate that the method should not be invoked based on the current state of the card.

See Also:

• Constant Field Values

Constructor Details

BioException

public BioException(short reason)

Construct a new biometric exception using a provided reason code. To conserve on resources use throwIt() to use the Java Card runtime environment instance of this class.

Parameters:

reason - the reason code for this exception.

Method Details

throwIt

public static void throwIt(short reason)
                    throws BioException

Throws the Java Card runtime environment owned instance of BioException 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 objects cannot be stored in class variables or instance variables or array components.

Parameters:

reason - the reason for the exception.

Throws:

BioException - always.