com.github.punch.api.exceptions

Class PunchlineException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.github.punch.api.exceptions.PunchlineException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PunchNodeException

public class PunchlineException
extends Exception

This is the base class for all PML configuration/validation exceptions.

The intent is to make it possible to provide a unified output to the user, or to the PunchPlatform HMI, with an exception subtyping and a json structure typing allowing the HMI to display errors on the PML model (e.g. subscription binding errors vs parameter typing error)

Author:

cedric

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PunchlineException() Ctor
PunchlineException(Exception e)
PunchlineException(String errorMessage)
PunchlineException(String errorMessage, Throwable cause)

Method Summary

Modifier and Type	Method and Description
String	getMessage()
String	toJson()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

PunchlineException

public PunchlineException(Exception e)

Parameters:

e - the source exception

PunchlineException

public PunchlineException()

Ctor

PunchlineException

public PunchlineException(String errorMessage)

Parameters:

errorMessage - the error message

PunchlineException

public PunchlineException(String errorMessage,
                          Throwable cause)

Parameters:

errorMessage - the error message

cause - the cause

Method Detail

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

toJson

public String toJson()

Returns:

a json representation