desmoj.core.exception

Class DESMOJException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

desmoj.core.exception.DESMOJException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

IllegalMoveException, SimAbortedException, SimFinishedException

public class DESMOJException
extends java.lang.RuntimeException

General exception for the desmoj simulation framework. All specific exceptions extend this class, thus building a hierarchic tree of possible exceptions being thrown by the framework and keeping all simulation related exceptions close together. Most exceptions are thrown when the continuation of the simulation can not be determined. This is especially the case with null references passed to a method expecting valid parameters. Note that these exceptions must not be caught by the user and that the user does not need to re-throw these exceptions, since they all inherit from class java.exception.RuntimeException which has the special feature to be re-thrown automatically by any method.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Tim lechler Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

See Also:

RuntimeException, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DESMOJException(ErrorMessage message) Constructs a standard DESMO-J exception with an error message needed to properly describe what error occurred, where it occurred, what reasons could be responsible for it and what could be done to prevent this error from occurring.
DESMOJException(ErrorMessage message, java.lang.Throwable cause) Constructs a standard DESMO-J exception with an error message needed to properly describe what error occurred, where it occurred, what reasons could be responsible for it and what could be done to prevent this error from occurring.

Method Summary

Modifier and Type	Method and Description
ErrorMessage	getErrorMessage() Returns the error message describing the circumstances leading to this exception being thrown.

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DESMOJException

public DESMOJException(ErrorMessage message)

Constructs a standard DESMO-J exception with an error message needed to properly describe what error occurred, where it occurred, what reasons could be responsible for it and what could be done to prevent this error from occurring.

Parameters:

message - desmoj.report.ErrorMessage : Describes the error leading to this exception

DESMOJException

public DESMOJException(ErrorMessage message,
                       java.lang.Throwable cause)

Constructs a standard DESMO-J exception with an error message needed to properly describe what error occurred, where it occurred, what reasons could be responsible for it and what could be done to prevent this error from occurring. The exception that caused this one is specified, too.

Parameters:

message - desmoj.report.ErrorMessage : Describes the error leading to this exception

cause - The exception describing the underlying cause.

Method Detail

getErrorMessage

public ErrorMessage getErrorMessage()

Returns the error message describing the circumstances leading to this exception being thrown. Use this method to extract the message and pass it to the Experiment's MessageDistributor to write it to the ErrorFile.

Returns:

desmoj.report.ErrorMessage : The errormessage describing the reasons for this Exception