org.opentrafficsim.core.distributions

Class ProbabilityException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.opentrafficsim.core.distributions.ProbabilityException

All Implemented Interfaces:

Serializable

public class ProbabilityException
extends Exception

Exception thrown when provided probabilities or frequencies are invalid. Negative probabilities or frequencies are invalid. A set of probabilities or frequencies that adds up to 0 causes this exception when the draw method is called.

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

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version Mar 1, 2016

Author:

Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProbabilityException()
ProbabilityException(String message)
ProbabilityException(String message, Throwable cause)
ProbabilityException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace)
ProbabilityException(Throwable cause)

Method Summary

Modifier and Type	Method and Description
static void	failIf(boolean condition, String message) Throw an Exception if a condition is met, e.g.

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

ProbabilityException

public ProbabilityException()

ProbabilityException

public ProbabilityException(String message)

Parameters:

message - String

ProbabilityException

public ProbabilityException(Throwable cause)

Parameters:

cause - Throwable

ProbabilityException

public ProbabilityException(String message,
                            Throwable cause)

Parameters:

message - String

cause - Throwable

ProbabilityException

public ProbabilityException(String message,
                            Throwable cause,
                            boolean enableSuppression,
                            boolean writableStackTrace)

Parameters:

message - String; description of the problem

cause - Throwable; the cause of this ValueException

enableSuppression - boolean; whether or not suppression is enabled or disabled

writableStackTrace - boolean; whether or not the stack trace should be writable

Method Detail

failIf

public static void failIf(boolean condition,
                          String message)
                   throws ProbabilityException

Throw an Exception if a condition is met, e.g. for pre- and postcondition checking.

Parameters:

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

message - the message to use in the exception

Throws:

ProbabilityException - the exception to throw on true condition