net.qrivy.jbioapi
Class BioApiException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          net.qrivy.jbioapi.BioApiException

All Implemented Interfaces:

java.io.Serializable

public class BioApiException
extends java.lang.Exception

A Java Exception corresponding to an error received from the BioAPI framework.

Author:

Michael R. Crusoe

See Also:

Serialized Form

Constructor Summary

BioApiException(long _errorCode)
Creates a new BioApiException based upon the given error code

Method Summary

java.lang.String	explain() Provides an explanation, if any, of this Exception
static java.lang.String	explain(long code) Provide an explanation, if any, of a given exception
long	getErrorCode()

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BioApiException

public BioApiException(long _errorCode)

Creates a new BioApiException based upon the given error code

Parameters:

_errorCode - As defined in the BioAPI 1.10 specification

See Also:

"bioapi_err.h"

Method Detail

getErrorCode

public long getErrorCode()

explain

public java.lang.String explain()

Provides an explanation, if any, of this Exception

Returns:

A String describing this Exception, if any -- otherwise a null

explain

public static java.lang.String explain(long code)

Provide an explanation, if any, of a given exception

Parameters:

code - The error code to explain

Returns:

A String describing the given error code, if any -- otherwise a null