org.thales.punch.libraries.punchlang.api

Class PunchRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.thales.punch.libraries.punchlang.api.PunchRuntimeException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PunchTupleFailureException

public class PunchRuntimeException
extends RuntimeException

A PunchRuntimeException is raised whenever a punchlet encounters an error. Typically the wrong type or an empty tuple is referenced. These kinds of erros cannot be recovered.

It is of highest importance to raise a useful error message to the user, one that pinpoint to the punchlet line where the error was thrown. Finding out that line number is the business implemented here.

The PunchCompileException stores the punchlet line number where the error was raised, so that the caller can react in a useful way. Typically an error message is included in the parsed log, so that the error can be detected without the log be lost.

If a punchlet suffers from a runtime jdk exception (i.e. ArrayOutOfBoundException), you can also get a PunchRuntimeException from it, that will pinpoint to the punchlet line where it actually happened.

Author:

dimi

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PunchRuntimeException() Constructs an PunchException with no detailed message.
PunchRuntimeException(Exception cause) Use this constructor after executing a punchlet, should it fail on a native runtime exception such as ArrayOutOfBoundException for example.
PunchRuntimeException(String msg) Constructs an PunchException with the specified detail message.
PunchRuntimeException(String msg, Exception cause)

Method Summary

Modifier and Type	Method and Description
int	getErrorLineNumber()
String	getLocation()

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

PunchRuntimeException

public PunchRuntimeException(Exception cause)

Use this constructor after executing a punchlet, should it fail on a native runtime exception such as ArrayOutOfBoundException for example.

The PunchRuntimeException will extract the punchlet path and linenumber from it, so that the user will be pointed to that exact line of punchlet code.

Parameters:

cause - the native root exception

PunchRuntimeException

public PunchRuntimeException(String msg,
                             Exception cause)

PunchRuntimeException

public PunchRuntimeException()

Constructs an PunchException with no detailed message. It will simply report the punchlet path:linenum where it happened.

PunchRuntimeException

public PunchRuntimeException(String msg)

Constructs an PunchException with the specified detail message.

Parameters:

msg - the detailed message.

Method Detail

getErrorLineNumber

public int getErrorLineNumber()

Returns:

the punchlet line number where the error occurred, or -1 if it could not be determined.

getLocation

public String getLocation()

Returns:

a ready to use error location message, "your_punchlet_name:error_line_num"