ch.trick17.betterchecks

Class InvalidCheckException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

ch.trick17.betterchecks.InvalidCheckException

All Implemented Interfaces:

Serializable

@GwtCompatible
public class InvalidCheckException
extends RuntimeException

Indicates that the contract of a check object has been violated. This is the fault of the "server" (the method that does the check) and not of the client (the code that uses that method).

Note: The validity of checks is only checked in few cases, so you should not rely on the Better Checks library to report erroneous uses of checks. Instead, keep your checks simple and refer to the documentation of each check method for precise information on what the method does.

For easier debugging, invalid check errors are reported by a separate type of exception instead of IllegalArgumentException, which could easily lead to confusion. This (and the fact that this exception does not extend IllegalArgumentException) also ensures that such errors are not accidentally caught by the client, which could turn an obvious bug in the server into a very-hard-to-find bug in the client.

Author:

Michael Faes

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidCheckException(String message) Constructs a new invalid check exception with the specified detail message.

Method Summary

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, 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

InvalidCheckException

public InvalidCheckException(String message)

Constructs a new invalid check exception with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(Throwable).

Parameters:

message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.