desmoj.core.report

Class ErrorMessage

java.lang.Object

desmoj.core.report.Message

desmoj.core.report.ErrorMessage

public class ErrorMessage
extends Message

An ErrorMessage is used to signal invalid situations to the modeller. An ErrorMessage consists of four Strings that intend to define the kind of error that occurred and describe its reason and what a modeller can do to prevent it. ErrorMessages describe types of errors that can be fixed by the DESMO-J or just give hints on missing or unclear parameters where certain framework assumptions are made. ErrorMessages report these to the modeller. Any type of error consists of the following attributes which have to be set by the ErrorMessage's constructor:

• error description : The operation that just failed or does not have the preconditions matched
• error location : The class and method that the error occurred in
• error reason : The probable reason why the error occured
• error prevention : A hint on how to prevent this error to occur again.
• error time : The point of simulation time that the error occurred.

Note that ErrorMessages relate to the modeller's use of the framework's methods and correct the found problems if possible by making assumptions. These corrections and their assumptions are articulated by an ErrorMessage. In contrast to Exceptions and fatal errors, an ErrorMessage does not stop the simulation run or exit the Java runtime.

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.

Constructor Summary

Constructors

Constructor and Description
ErrorMessage(Model origin, java.lang.String errorDescription, java.lang.String errorLocation, java.lang.String errorReason, java.lang.String errorPrevention, TimeInstant errorTime) Creates an errormessage setting its parameters with the given values.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLocation() Returns a String describing class and method that this message was sent from.
java.lang.String	getPrevention() Returns a String giving a hint on how to prevent this error to happen.
java.lang.String	getReason() Returns the String describing the probable reason for the error to occur.

Methods inherited from class desmoj.core.report.Message

getDescription, getExperimentName, getModelName, getSendTime, getTime, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorMessage

public ErrorMessage(Model origin,
                    java.lang.String errorDescription,
                    java.lang.String errorLocation,
                    java.lang.String errorReason,
                    java.lang.String errorPrevention,
                    TimeInstant errorTime)

Creates an errormessage setting its parameters with the given values.

Parameters:

origin - Model : The model this errormessage evolved from

errorDescription - java.lang.String : Description of the error

errorLocation - java.lang.String : Class and method the error occured in

errorReason - java.lang.String : The probable reason for the error

errorPrevention - java.lang.String : A hint how to prevent the error

Method Detail

getLocation

public java.lang.String getLocation()

Returns a String describing class and method that this message was sent from.

Returns:

java.lang.String : The location this message was sent from.

getPrevention

public java.lang.String getPrevention()

Returns a String giving a hint on how to prevent this error to happen. Note that the hint given is based on the probable reason described but must not always have that reason.

Returns:

java.lang.String : The probable reason for this error

getReason

public java.lang.String getReason()

Returns the String describing the probable reason for the error to occur. Note that the reason given here is the most probable reason for the effect to occur here. It might have its origin in other classes, so bear in mind that the casue for the error might have been created in a class not obviously related to the location this error occured.

Returns:

java.lang.String : The probable reason for this error