flexagon.ff.common.core.exceptions

Class FlexCheckedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

flexagon.ff.common.core.exceptions.FlexCheckedException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

FlexNotFoundException, FlexRemotePluginException, FlexRestException

public class FlexCheckedException
extends java.lang.Exception

Base class for all FlexDeploy Checked Exceptions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FlexCheckedException() Default constructor.
FlexCheckedException(java.lang.String pMessage) Creates an exception with the given message.
FlexCheckedException(java.lang.String pMessage, boolean pLogOnInit) Creates an exception with the given message
FlexCheckedException(java.lang.String pCode, java.lang.String pMessage) Creates an exception with the given name and code.
FlexCheckedException(java.lang.String pCode, java.lang.String pMessage, java.lang.Throwable pThrowable) Creates an exception with the given code, message, and cause.
FlexCheckedException(java.lang.String pMessage, java.lang.Throwable pThrowable) Creates an exception with the given message an cause.
FlexCheckedException(java.lang.Throwable pThrowable) Creates an exception with the given cause

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() Returns the exception code.
java.lang.String	getMessage()
java.lang.String	getPlainMessage() Returns error message without exception code.
protected void	log() Logs exception information on initialization
protected boolean	logOnInit() Checks whether to log on initialization of this exception
void	setCode(java.lang.String pCode) Sets the exception code.

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

FlexCheckedException

public FlexCheckedException()

Default constructor. Logs on initialization by default.

FlexCheckedException

public FlexCheckedException(java.lang.String pMessage,
                            boolean pLogOnInit)

Creates an exception with the given message

Parameters:

pMessage - the exception message

pLogOnInit - whether or not to log on initialization

FlexCheckedException

public FlexCheckedException(java.lang.String pMessage)

Creates an exception with the given message. Logs on initialization by default.

Parameters:

pMessage - the exception message

FlexCheckedException

public FlexCheckedException(java.lang.String pCode,
                            java.lang.String pMessage)

Creates an exception with the given name and code. The code is intended to uniquely identify a place in code where the exception originated, eliminating the need for a Stacktrace to identify the source. A code should identify the vendor and have a unique numeric code. For example, Flexagon/FlexDeploy uses - (e.g. FDML-15001).

Parameters:

pCode - - a short code uniquely identifying where an exception is raised.

pMessage - - an exception message.

FlexCheckedException

public FlexCheckedException(java.lang.Throwable pThrowable)

Creates an exception with the given cause

Parameters:

pThrowable - the cause of the exception

FlexCheckedException

public FlexCheckedException(java.lang.String pMessage,
                            java.lang.Throwable pThrowable)

Creates an exception with the given message an cause.

Parameters:

pMessage - the exception message

pThrowable - the cause of the exception

FlexCheckedException

public FlexCheckedException(java.lang.String pCode,
                            java.lang.String pMessage,
                            java.lang.Throwable pThrowable)

Creates an exception with the given code, message, and cause. The code is intended to uniquely identify a place in code where the exception originated, eliminating the need for a Stacktrace to identify the source. A code should identify the vendor and have a unique numeric code. For example, Flexagon/FlexDeploy uses - (e.g. FDML-15001).

Parameters:

pCode - the exception code

pMessage - the exception message

pThrowable - the cause of the exception

Method Detail

setCode

public void setCode(java.lang.String pCode)

Sets the exception code.

Parameters:

pCode - the exception code

getCode

public java.lang.String getCode()

Returns the exception code.

Returns:

the exception code

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

log

protected void log()

Logs exception information on initialization

logOnInit

protected boolean logOnInit()

Checks whether to log on initialization of this exception

Returns:

true if set to log on initialization; false otherwise

getPlainMessage

public java.lang.String getPlainMessage()

Returns error message without exception code.

Returns:

the exception method without the exception code