com.highqsoft.fwk

Class FwkException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.highqsoft.fwk.FwkException

All Implemented Interfaces:

FwkExceptionInterface, FwkInterface, FwkPresentationInterface, java.io.Serializable

public class FwkException
extends java.lang.RuntimeException
implements FwkExceptionInterface

The FwkException is the basic Exception used by this component architecture.

Since:

$Date: 2017/04/28 08:47:40 $

Version:

$Revision: 1.16 $

Author:

HighQSoft GmbH

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	version

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkExceptionInterface

ERROR, INFORMATIONAL, WARNING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FwkException() The default constructor.
	FwkException(int number, java.lang.String filename, java.lang.String revision, java.lang.String ident, java.lang.String parameter, java.lang.Object srcObj, java.lang.Throwable srcThr) The constructor of the execption.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClassName() Get the sourcecode filename of the exception.
java.lang.String	getCodeVersion() Get the revision of the sourcecode file of the exception.
java.lang.String	getFilename() Get the current exception source filename.
FwkArrayInterface	getFwkMimeTypes() Return the mimetypes of this component.
java.lang.String	getIdent() Get the current ident of the exception.
java.lang.String	getMessage() Get the message of the exception.
int	getNumber() Get the error number of the exception.
java.lang.String	getParameter() Get the parameter string of the exception.
java.lang.String	getParams() This function returns a string containing all parameter of the object.
java.lang.String	getPresentationString() Retrieves the representation string.
java.lang.String	getPresentationString(java.util.Locale l) Retrieves the representation string.
java.lang.Object	getSourceObject() Get the source object of the exception.
java.lang.Throwable	getSourceThrowable() Get the source throwable of the exception.
java.lang.String	getVersion() Return the version string of the FWK component.
void	release() Release the object.
void	setClassName(java.lang.String className) Set the class name of the source of the exception.
void	setCodeVersion(java.lang.String newVersion) Set the revision of the sourcecode file of the exception.
void	setFilename(java.lang.String newFilename) Set the filename where the exception was thrown.
void	setIdent(java.lang.String newIdent) Set the identification of the exception.
void	setNumber(int number) Set the error number of the exception.
void	setParameter(java.lang.String newParameter) Set the parameter string of the exception.
void	setSourceObject(java.lang.Object srcObject) Set the source object of the exception.
void	setSourceThrowable(java.lang.Throwable srcThrowable) Set the source throwable of the exception.
java.lang.String	sourceThrowableToString() Returns the string representation of the source exception.
java.lang.String	toString() This function returns a string containing the string representation of the object.
void	write() Write the exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

Constructor Detail

FwkException

protected FwkException()

The default constructor.

FwkException

public FwkException(int number,
            java.lang.String filename,
            java.lang.String revision,
            java.lang.String ident,
            java.lang.String parameter,
            java.lang.Object srcObj,
            java.lang.Throwable srcThr)

The constructor of the execption. This type of constructor write the exception immediately.

Parameters:

number - The error number of the exception. Use the predefined numbers from ErrorNumber class

filename - The Java filename in which the problem occurred.

revision - The version of the sourcecode file.

ident - The identifier of the exception. It shoudl be uniq inside one source code file to find the place where the exception was thrown.

parameter - The parameter string of the exception. It depends on the message number.

srcObj - The object that has this exception thrown.

srcThr - The throwable that is the source for that exception.

See Also:

ErrorNumber

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

release

public void release()

Release the object.

Specified by:

release in interface FwkInterface

getFwkMimeTypes

public FwkArrayInterface getFwkMimeTypes()

Return the mimetypes of this component.

getPresentationString

public java.lang.String getPresentationString(java.util.Locale l)

Retrieves the representation string. Currently it returns the name.

Specified by:

getPresentationString in interface FwkPresentationInterface

Parameters:

l - The Locale object or null.

Returns:

The presentation string.

getPresentationString

public java.lang.String getPresentationString()

Retrieves the representation string. Currently it returns the name.

Specified by:

getPresentationString in interface FwkPresentationInterface

Returns:

The presentation string.

write

public void write()

Write the exception.

Specified by:

write in interface FwkExceptionInterface

setIdent

public void setIdent(java.lang.String newIdent)

Set the identification of the exception.

Specified by:

setIdent in interface FwkExceptionInterface

Parameters:

ident - The new uniq identifier of the exception.

See Also:

getIdent

getIdent

public java.lang.String getIdent()

Get the current ident of the exception.

Specified by:

getIdent in interface FwkExceptionInterface

Returns:

The identification string of the exception.

See Also:

setIdent

setFilename

public void setFilename(java.lang.String newFilename)

Set the filename where the exception was thrown.

Specified by:

setFilename in interface FwkExceptionInterface

Parameters:

filename - The name of the file.

See Also:

getFilename

getFilename

public java.lang.String getFilename()

Get the current exception source filename.

Specified by:

getFilename in interface FwkExceptionInterface

Returns:

The the exception source filename.

See Also:

setFilename

setNumber

public void setNumber(int number)

Set the error number of the exception. Use the predefined error codes.

Specified by:

setNumber in interface FwkExceptionInterface

Parameters:

number - The new error number of the exception.

See Also:

getNumber

getNumber

public int getNumber()

Get the error number of the exception.

Specified by:

getNumber in interface FwkExceptionInterface

Returns:

The error number of the exception.

See Also:

setNumber

setClassName

public void setClassName(java.lang.String className)

Set the class name of the source of the exception.

Specified by:

setClassName in interface FwkExceptionInterface

Parameters:

filename - The source class name of the exception.

See Also:

getFilename

getClassName

public java.lang.String getClassName()

Get the sourcecode filename of the exception.

Specified by:

getClassName in interface FwkExceptionInterface

Returns:

The sourcecode filename of the exception.

See Also:

setFilename

setCodeVersion

public void setCodeVersion(java.lang.String newVersion)

Set the revision of the sourcecode file of the exception.

Specified by:

setCodeVersion in interface FwkExceptionInterface

Parameters:

revision - The version of the code file.

See Also:

getCodeVersion

getCodeVersion

public java.lang.String getCodeVersion()

Get the revision of the sourcecode file of the exception.

Specified by:

getCodeVersion in interface FwkExceptionInterface

Returns:

The revision string of the exception.

See Also:

setCodeVersion

setParameter

public void setParameter(java.lang.String newParameter)

Set the parameter string of the exception.

Specified by:

setParameter in interface FwkExceptionInterface

Parameters:

parameter - The new parameter string of the exception.

See Also:

getParameter

getParameter

public java.lang.String getParameter()

Get the parameter string of the exception.

Specified by:

getParameter in interface FwkExceptionInterface

Returns:

The parameter string of the exception.

See Also:

setParamter

setSourceObject

public void setSourceObject(java.lang.Object srcObject)

Set the source object of the exception.

Specified by:

setSourceObject in interface FwkExceptionInterface

Parameters:

srcObject - The source object of the exception.

See Also:

getSourceObject

getSourceObject

public java.lang.Object getSourceObject()

Get the source object of the exception.

Specified by:

getSourceObject in interface FwkExceptionInterface

Returns:

The source object of the message.

See Also:

setSourceObject

setSourceThrowable

public void setSourceThrowable(java.lang.Throwable srcThrowable)

Set the source throwable of the exception.

Specified by:

setSourceThrowable in interface FwkExceptionInterface

Parameters:

srcThrowable - The source throwable of the exception.

See Also:

getSourceThrowable

getSourceThrowable

public java.lang.Throwable getSourceThrowable()

Get the source throwable of the exception.

Specified by:

getSourceThrowable in interface FwkExceptionInterface

Returns:

The source throwable of the message.

See Also:

setSourceThrowable

sourceThrowableToString

public java.lang.String sourceThrowableToString()

Returns the string representation of the source exception.

getParams

public java.lang.String getParams()

This function returns a string containing all parameter of the object.

Returns:

The string representation of the parameters of the object.

See Also:

toString

getMessage

public java.lang.String getMessage()

Get the message of the exception.

Overrides:

getMessage in class java.lang.Throwable

toString

public java.lang.String toString()

This function returns a string containing the string representation of the object.

Overrides:

toString in class java.lang.Throwable

Returns:

The string representation of the object.

See Also:

getParams