org.jocl
Class CLException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by org.jocl.CLException
All Implemented Interfaces:
java.io.Serializable

public class CLException
extends java.lang.RuntimeException

An exception that may be thrown due to a OpenCL error.

Exceptions may be enabled or disabled using CL#setExceptionsEnabled(boolean). If exceptions are enabled, the JOCL methods will throw a CLException if the OpenCL function did not return CL_SUCCESS.

See Also:
Serialized Form

Constructor Summary
CLException(java.lang.String message)
          Creates a new CLException with the given error message.
CLException(java.lang.String message, int status)
          Creates a new CLException with the given error message.
CLException(java.lang.String message, java.lang.Throwable cause)
          Creates a new CLException with the given error message.
CLException(java.lang.String message, java.lang.Throwable cause, int status)
          Creates a new CLException with the given error message.
 
Method Summary
 int getStatus()
          Returns the status code from OpenCL that caused this exception.
 
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CLException

public CLException(java.lang.String message)
Creates a new CLException with the given error message.

Parameters:
message - The error message for this CLException

CLException

public CLException(java.lang.String message,
                   int status)
Creates a new CLException with the given error message.

Parameters:
message - The error message for this CLException
status - The status code from OpenCL

CLException

public CLException(java.lang.String message,
                   java.lang.Throwable cause)
Creates a new CLException with the given error message.

Parameters:
message - The error message for this CLException
cause - The throwable that caused this exception

CLException

public CLException(java.lang.String message,
                   java.lang.Throwable cause,
                   int status)
Creates a new CLException with the given error message.

Parameters:
message - The error message for this CLException
cause - The throwable that caused this exception
status - The status code from OpenCL
Method Detail

getStatus

public int getStatus()
Returns the status code from OpenCL that caused this exception. For example, the value of

Returns:
The OpenCL status code