ch.trick17.betterchecks

Class Exceptions

java.lang.Object

ch.trick17.betterchecks.Exceptions

@GwtCompatible
public final class Exceptions
extends Object

Helper class that provides several methods for creating exceptions and formatting exception messages. It is intended only for internal and testing use and provides convenient access to all exception-related configuration aspects (which is actually all the configuration aspects so far) so that the other classes do not need to depend on the Config class directly.

The ...Exception(...) methods all return exceptions of the type indicated by the method name with their stack traces cleaned up. This feature is described in the documentation of the Check class.

The stack trace cleaning is implemented by removing from the top of the stack trace all stack frames belonging to methods that are part of the Better Checks library. A method is defined to be part of the Better Checks library iff it belongs to a class that is located in the base package of the library (ch.trick17.betterchecks) or one of its subpackages. Exceptionally, for testing purposes, classes ending in "Test" are not considered to be part of the library.

Author:

Michael Faes

Method Summary

Modifier and Type	Method and Description
static String	defaultArgName() A convenience method that returns the default argument name from the configuration.
static String	formatMsg(MessageType msgType, boolean inverted, Object... msgArgs) Formats an exception message using the format corresponding to the given message type and the given message arguments.
static IllegalArgumentException	illegalArgumentException(MessageType msgType, boolean inverted, Object[] msgArgs) Returns an IllegalArgumentException with a message formatted using the format corresponding to the given message type and the given message arguments.
static IllegalArgumentException	illegalArgumentException(MessageType msgType, boolean inverted, Object[] msgArgs, Throwable cause) Returns an IllegalArgumentException with a message formatted using the format corresponding to the given message type and the given message arguments.
static IllegalArgumentException	illegalArgumentException(String message) Returns an IllegalArgumentException with the given exception message and a cleaned-up stack trace (if enabled).
static IllegalStateException	illegalStateException(String message) Returns an IllegalStateException with the given exception message and a cleaned-up stack trace (if enabled).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

illegalArgumentException

public static IllegalArgumentException illegalArgumentException(String message)

Returns an IllegalArgumentException with the given exception message and a cleaned-up stack trace (if enabled).

Parameters:

message - The exception message

Returns:

such an exception

illegalArgumentException

public static IllegalArgumentException illegalArgumentException(MessageType msgType,
                                                                boolean inverted,
                                                                Object[] msgArgs)

Returns an IllegalArgumentException with a message formatted using the format corresponding to the given message type and the given message arguments. If inverted is true, the inverted message format will be used. Also, the stack trace of the exception will be cleaned (if enabled).

See Config.getMessageFormat(MessageType, boolean) for more information about exception message formats.

Parameters:

msgType - The message type indicating the message format to use

inverted - If true, the inverted format is used

msgArgs - The message arguments

Returns:

such an exception

illegalArgumentException

public static IllegalArgumentException illegalArgumentException(MessageType msgType,
                                                                boolean inverted,
                                                                Object[] msgArgs,
                                                                Throwable cause)

Returns an IllegalArgumentException with a message formatted using the format corresponding to the given message type and the given message arguments. If inverted is true, the inverted message format will be used. Also, the cause of the message is set to the one given and the stack trace of the exception will be cleaned (if enabled).

See Config.getMessageFormat(MessageType, boolean) for more information about exception message formats.

Parameters:

msgType - The message type indicating the message format to use

inverted - If true, the inverted format is used

msgArgs - The message arguments

cause - The cause for the exception

Returns:

such an exception

illegalStateException

public static IllegalStateException illegalStateException(String message)

Returns an IllegalStateException with the given exception message and a cleaned-up stack trace (if enabled).

Parameters:

message - The exception message

Returns:

such an exception

formatMsg

public static String formatMsg(MessageType msgType,
                               boolean inverted,
                               Object... msgArgs)

Formats an exception message using the format corresponding to the given message type and the given message arguments. If inverted is true, the inverted message format will be used.

Parameters:

msgType - The message type indicating the message format to use

inverted - If true, the inverted format is used

msgArgs - The message arguments

Returns:

The formatted exception message

defaultArgName

public static String defaultArgName()

A convenience method that returns the default argument name from the configuration.

Returns:

Config.getDefaultArgumentName()