**javacardx.biometry** 
 ====Class BioException  ====
  *[[javacard:java-card-api:object|java.lang.Object]] \\ 
    *[[javacard:java-card-api:throwable|java.lang.Throwable]] \\ 
      *[[javacard:java-card-api:exception|java.lang.Exception]] \\ 
        *[[javacard:java-card-api:runtimeexception|java.lang.RuntimeException]] \\ 
          *[[javacard:java-card-api:cardruntimeexception|javacard.framework.CardRuntimeException]] \\ 


 ----

public class **BioException**extends [[javacard:java-card-api:CardRuntimeException|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 ^^ 
| **static short** | **[[javacard:java-card-api:BioException#ILLEGAL_USE|ILLEGAL_USE]] **          This reason code is used to indicate that the method should not beinvoked based on the current state of the card. |
| **static short** | **[[javacard:java-card-api:BioException#ILLEGAL_VALUE|ILLEGAL_VALUE]] **          This reason code is used to indicate that one or more input parameters isout of allowed bounds. |
| **static short** | **[[javacard:java-card-api:BioException#INVALID_DATA|INVALID_DATA]] **          This reason code is used to indicate that the data the system encounteredis illegible. |
| **static short** | **[[javacard:java-card-api:BioException#NO_SUCH_BIO_TEMPLATE|NO_SUCH_BIO_TEMPLATE]] **          This reason code is used to indicate that the provided bio template typeis not supported by the template builder. |
| **static short** | **[[javacard:java-card-api:BioException#NO_TEMPLATES_ENROLLED|NO_TEMPLATES_ENROLLED]] **          This reason code is used to indicate that no reference template isavailable for matching, or that the reference template is uninitialized. |

 




^ Constructor Summary ^^ 
| **[[javacard:java-card-api:BioException#BioException(short)|BioException]] **(short reason)          Construct a new biometric exception using a provided reason code. |

 




^ Method Summary ^^ 
| **static void** | **[[javacard:java-card-api:BioException#throwIt(short)|throwIt]] **(short reason)          Throws the Java Card runtime environment owned instance of BioException with the specified reason. |

 

^ Methods inherited from class javacard.framework.CardRuntimeException ^ 
| [[javacard:java-card-api:CardRuntimeException#getReason()|getReason]] , [[javacard:java-card-api:CardRuntimeException#setReason(short)|setReason]]  |

 

^ Methods inherited from class java.lang.Object ^ 
| [[javacard:java-card-api:Object#equals(java.lang.Object)|equals]]  |

 






^ Field Detail ^ 



 === 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:**[[javacard:java-card-api:constant-values#javacardx.biometry.BioException.ILLEGAL_VALUE|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:**[[javacard:java-card-api:constant-values#javacardx.biometry.BioException.INVALID_DATA|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:**[[javacard:java-card-api:constant-values#javacardx.biometry.BioException.NO_SUCH_BIO_TEMPLATE|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:**[[javacard:java-card-api:constant-values#javacardx.biometry.BioException.NO_TEMPLATES_ENROLLED|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:**[[javacard:java-card-api:constant-values#javacardx.biometry.BioException.ILLEGAL_USE|Constant Field Values]]  
 

 
 






^ Constructor Detail ^ 



 === 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 Detail ^ 



 === throwIt === 
public static void **throwIt**(short reason)
throws [[javacard:java-card-api:BioException|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:**
[[javacard:java-card-api:BioException|BioException]]  - always.