org.opentrafficsim.core

Class Throw

java.lang.Object

org.opentrafficsim.core.Throw

public final class Throw
extends Object

The Throw class has a number of static methods that make it easy to throw an exception under conditions for any Exception class, including the standard Java exceptions and exceptions from libraries that are used in the project. Instead of:

 if (Double.isNaN(gtu.getPosition.si))
 {
     throw new GTUException("position is NaN for GTU " + gtu.getId());
 }
 

we can write:

 Throw.when(Double.isNaN(gtu.getPosition.si), GTUException.class, "position is NaN for GTU %s", gtu.getId());
 

Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Apr 22, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Method Summary

Modifier and Type	Method and Description
static <T extends Throwable> void	when(boolean condition, Class<T> throwableClass, String message) Throw a Throwable (such as an Exception or Error) if a condition is met, e.g.
static <T extends Throwable> void	when(boolean condition, Class<T> throwableClass, String message, Object arg) Throw a Throwable (such as an Exception or Error) if a condition is met, e.g.
static <T extends Throwable> void	when(boolean condition, Class<T> throwableClass, String message, Object arg1, Object arg2) Throw a Throwable (such as an Exception or Error) if a condition is met, e.g.
static <T extends Throwable> void	when(boolean condition, Class<T> throwableClass, String message, Object arg1, Object arg2, Object arg3) Throw a Throwable (such as an Exception or Error) if a condition is met, e.g.
static <T extends Throwable> void	when(boolean condition, Class<T> throwableClass, String message, Object arg1, Object arg2, Object arg3, Object... args) Throw a Throwable (such as an Exception or Error) if a condition is met, e.g.
static void	whenNull(Object object, String message) Throw a NullPointerException if object is null, e.g.
static void	whenNull(Object object, String message, Object arg) Throw a NullPointerException if object is null, e.g.
static void	whenNull(Object object, String message, Object arg1, Object arg2) Throw a NullPointerException if object is null, e.g.
static void	whenNull(Object object, String message, Object arg1, Object arg2, Object arg3) Throw a NullPointerException if object is null, e.g.
static void	whenNull(Object object, String message, Object arg1, Object arg2, Object arg3, Object... args) Throw a NullPointerException if object is null, e.g.

Methods inherited from class java.lang.Object

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

Method Detail

when

public static <T extends Throwable> void when(boolean condition,
                                              Class<T> throwableClass,
                                              String message)
                                       throws T extends Throwable

Throw a Throwable (such as an Exception or Error) if a condition is met, e.g. for pre- and postcondition checking. Use as follows:
Throw.when(value == null, GTUException.class, "value cannot be null"); TODO this example is badly chosen; to test for null; call whenNull.

Type Parameters:

T - the Throwable type

Parameters:

condition - the condition to check; an exception will be thrown if this is true

throwableClass - the Throwable type to throw

message - the message to use in the exception

Throws:

T - the throwable to throw on true condition

T extends Throwable

when

public static <T extends Throwable> void when(boolean condition,
                                              Class<T> throwableClass,
                                              String message,
                                              Object arg)
                                       throws T extends Throwable

Throw a Throwable (such as an Exception or Error) if a condition is met, e.g. for pre- and postcondition checking. Use as follows:
Throw.when(value == null, GTUException.class, "value cannot be null for GTU with id = %s", id);

Type Parameters:

T - the Throwable type

Parameters:

condition - the condition to check; an exception will be thrown if this is true

throwableClass - the Throwable type to throw

message - the message to use in the exception, with formatting identifiers

arg - value to use for the formatting identifiers

Throws:

T - the throwable to throw on true condition

T extends Throwable

when

public static <T extends Throwable> void when(boolean condition,
                                              Class<T> throwableClass,
                                              String message,
                                              Object arg1,
                                              Object arg2)
                                       throws T extends Throwable

Throw a Throwable (such as an Exception or Error) if a condition is met, e.g. for pre- and postcondition checking. Use as follows:
Throw.when(value == null, GTUException.class, "value cannot be null for GTU %s with id %s", name, id);

Type Parameters:

T - the Throwable type

Parameters:

condition - the condition to check; an exception will be thrown if this is true

throwableClass - the Throwable type to throw

message - the message to use in the exception, with formatting identifiers

arg1 - 1st value to use for the formatting identifiers

arg2 - 2nd value to use for the formatting identifiers

Throws:

T - the throwable to throw on true condition

T extends Throwable

when

public static <T extends Throwable> void when(boolean condition,
                                              Class<T> throwableClass,
                                              String message,
                                              Object arg1,
                                              Object arg2,
                                              Object arg3)
                                       throws T extends Throwable

Throw a Throwable (such as an Exception or Error) if a condition is met, e.g. for pre- and postcondition checking. Use as follows:
Throw.when(value == null, GTUException.class, "value cannot be null for GTU %s with id %s", name, id);

Type Parameters:

T - the Throwable type

Parameters:

condition - the condition to check; an exception will be thrown if this is true

throwableClass - the Throwable type to throw

message - the message to use in the exception, with formatting identifiers

arg1 - 1st value to use for the formatting identifiers

arg2 - 2nd value to use for the formatting identifiers

arg3 - 3rd value to use for the formatting identifiers

Throws:

T - the throwable to throw on true condition

T extends Throwable

when

public static <T extends Throwable> void when(boolean condition,
                                              Class<T> throwableClass,
                                              String message,
                                              Object arg1,
                                              Object arg2,
                                              Object arg3,
                                              Object... args)
                                       throws T extends Throwable

Throw a Throwable (such as an Exception or Error) if a condition is met, e.g. for pre- and postcondition checking. Use as follows:
Throw.when(value == null, GTUException.class, "value cannot be null for GTU with id = %s", id);

Type Parameters:

T - the Throwable type

Parameters:

condition - the condition to check; an exception will be thrown if this is true

throwableClass - the Throwable type to throw

message - the message to use in the exception, with formatting identifiers

arg1 - 1st value to use for the formatting identifiers

arg2 - 2nd value to use for the formatting identifiers

arg3 - 3rd value to use for the formatting identifiers

args - potential 4th and further values to use for the formatting identifiers

Throws:

T - the throwable to throw on true condition

T extends Throwable

whenNull

public static void whenNull(Object object,
                            String message)
                     throws NullPointerException

Throw a NullPointerException if object is null, e.g. for pre- and postcondition checking. Use as follows:
Throw.whenNull(value, "value cannot be null");

Parameters:

object - object to check; an exception will be thrown if this is null

message - the message to use in the exception

Throws:

NullPointerException - if object is null

whenNull

public static void whenNull(Object object,
                            String message,
                            Object arg)
                     throws NullPointerException

Throw a NullPointerException if object is null, e.g. for pre- and postcondition checking. Use as follows:
Throw.whenNull(value, "value cannot be null for GTU with id = %s", id);

Parameters:

object - object to check; an exception will be thrown if this is null

message - the message to use in the exception, with formatting identifiers

arg - value to use for the formatting identifiers

Throws:

NullPointerException - if object is null

whenNull

public static void whenNull(Object object,
                            String message,
                            Object arg1,
                            Object arg2)
                     throws NullPointerException

Throw a NullPointerException if object is null, e.g. for pre- and postcondition checking. Use as follows:
Throw.whenNull(value, "value cannot be null for GTU %s with id %s", name, id);

Parameters:

object - object to check; an exception will be thrown if this is null

message - the message to use in the exception, with formatting identifiers

arg1 - 1st value to use for the formatting identifiers

arg2 - 2nd value to use for the formatting identifiers

Throws:

NullPointerException - if object is null

whenNull

public static void whenNull(Object object,
                            String message,
                            Object arg1,
                            Object arg2,
                            Object arg3)
                     throws NullPointerException

Throw a NullPointerException if object is null, e.g. for pre- and postcondition checking. Use as follows:
Throw.whenNull(value, "value cannot be null for GTU %s with id %s", name, id);

Parameters:

object - object to check; an exception will be thrown if this is null

message - the message to use in the exception, with formatting identifiers

arg1 - 1st value to use for the formatting identifiers

arg2 - 2nd value to use for the formatting identifiers

arg3 - 3rd value to use for the formatting identifiers

Throws:

NullPointerException - if object is null

whenNull

public static void whenNull(Object object,
                            String message,
                            Object arg1,
                            Object arg2,
                            Object arg3,
                            Object... args)
                     throws NullPointerException

Throw a NullPointerException if object is null, e.g. for pre- and postcondition checking. Use as follows:
Throw.whenNull(value, "value cannot be null for GTU %s with id %s", name, id);

Parameters:

object - object to check; an exception will be thrown if this is null

message - the message to use in the exception, with formatting identifiers

arg1 - 1st value to use for the formatting identifiers

arg2 - 2nd value to use for the formatting identifiers

arg3 - 3rd value to use for the formatting identifiers

args - potential 4th and further values to use for the formatting identifiers

Throws:

NullPointerException - if object is null