com.highqsoft.fwk.exception

Class FwkExceptionWriter

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.exception.FwkExceptionWriter

All Implemented Interfaces:

FwkExceptionWriterInterface, FwkInterface, java.io.Serializable

public class FwkExceptionWriter
extends Fwk
implements FwkExceptionWriterInterface, FwkInterface

The FwkExceptionWriter. Use the Keyword ExceptionWriter.Class to establish a private writer object. This class must implement the interface FwkExceptionWriterInterace to be a valid writer.
Because the intialization of the ExeptionWriter is one of the first thing, the keyword will be recognize from command line argument only.
javac -ExceptionWriter.Class

Property Keyword	Datatype	Default	Description
ExceptionWriter.Class	classname	com.highqsoft.fwk.exception.FwkLibraryWriter	The classname of the eception writer.

Since:

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

Version:

$Revision: 1.15 $

Author:

HighQSoft GmbH

See Also:

, Serialized Form

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the communication to the event logger.
java.lang.Throwable	getException() Returns the exception that is occurred, if the writer isn't alive.
static FwkExceptionWriter	getInstance() Get the singleton instance of the object.
java.lang.String	getParams() This function returns a string containing all parameters of the object.
java.lang.String	getVersion() Return the version string of the FWK component.
void	init(java.lang.String program, java.lang.String version, java.lang.String[] args) Initialize the communication to the event logger.
boolean	isAlive() Returns whether the writer was successfully initialized.
boolean	isError(int code) Return true if event code signals an error.
boolean	isInformation(int code) Return true if event code signals an informational message.
boolean	isOccurred() Indicates whether an event is occurred.
boolean	isWarning(int code) Return true if event code signals a warning.
void	put(FwkExceptionInterface exception) Put an event to the event logger.
void	put(int code, java.lang.String className, java.lang.String fileName, java.lang.String version, java.lang.String lineIdent, java.lang.String parameter) Put an event to the event logger.
void	reset() Reset the the current error messages.
java.lang.String	toString() Get the string representation of the object.
static void	write(FwkExceptionInterface exception) Put an exception to the event logger.
static void	write(int code, java.lang.String className, java.lang.String fileName, java.lang.String version, java.lang.String lineIdent, java.lang.String parameter) Put an event to the event logger.

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion, release

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

release

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

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

Overrides:

getVersion in class Fwk

getInstance

public static FwkExceptionWriter getInstance()

Get the singleton instance of the object.

isAlive

public boolean isAlive()

Returns whether the writer was successfully initialized.

Specified by:

isAlive in interface FwkExceptionWriterInterface

Returns:

True if the writer is initialized.

getException

public java.lang.Throwable getException()

Returns the exception that is occurred, if the writer isn't alive.

Specified by:

getException in interface FwkExceptionWriterInterface

Returns:

The exception thown by the static initializer.

init

public void init(java.lang.String program,
        java.lang.String version,
        java.lang.String[] args)

Initialize the communication to the event logger. Reset the writer inside this routine.

Specified by:

init in interface FwkExceptionWriterInterface

Parameters:

name - Name of program.

version - Version of the program.

args - Main program parameters.

write

public static void write(int code,
         java.lang.String className,
         java.lang.String fileName,
         java.lang.String version,
         java.lang.String lineIdent,
         java.lang.String parameter)

Put an event to the event logger. When more than 10 (MAX_ERROR)identical events occurred the report of the event is suppressed.

The compiler definition NOTRACE suppresses the message AO_EVENT. The message AO_EVENT is used to trace back the calling sequence of the function where the error occures.

If this function is called an error is occurred and the flag is set.

Parameters:

number - Number of the event to report.

className - Name of the class that has thrown the exception.

fileName - Name of the sourcefile.

revision - Revision of the sourcefile.

lineIdent - Identification string for the line in the sourcefile.

parameter - Event parameter.

put

public void put(int code,
       java.lang.String className,
       java.lang.String fileName,
       java.lang.String version,
       java.lang.String lineIdent,
       java.lang.String parameter)

Description copied from interface: FwkExceptionWriterInterface

Put an event to the event logger. When more than 10 (MAX_ERROR)identical events occurred the report of the event is suppressed.

The compiler definition NOTRACE suppresses the message AO_EVENT. The message AO_EVENT is used to trace back the calling sequence of the function where the error occurs.

If this function is called an error is occurred and the flag is set.

Specified by:

put in interface FwkExceptionWriterInterface

fileName - Name of the sourcefile.

version - Revision of the sourcefile.

lineIdent - Identification string for the line in the sourcefile.

parameter - Event parameter.

write

public static void write(FwkExceptionInterface exception)

Put an exception to the event logger. When more than 10 (MAX_ERROR)identical events occurred the report of the event is suppressed.

The compiler definition NOTRACE suppresses the message AO_EVENT. The message AO_EVENT is used to trace back the calling sequence of the function where the error occures.

If this function is called an error is occurred and the flag is set.

Parameters:

exception - The FwkException to be written.

put

public void put(FwkExceptionInterface exception)

Description copied from interface: FwkExceptionWriterInterface

Put an event to the event logger. When more than 10 (MAX_ERROR)identical events occurred the report of the event is suppressed.

The compiler definition NOTRACE suppresses the message AO_EVENT. The message AO_EVENT is used to trace back the calling sequence of the function where the error occurs.

If this function is called an error is occurred and the flag is set.

Specified by:

put in interface FwkExceptionWriterInterface

Parameters:

exception - The exception that should be written.

close

public void close()

Close the communication to the event logger.

Specified by:

close in interface FwkExceptionWriterInterface

isError

public boolean isError(int code)

Return true if event code signals an error.

Specified by:

isError in interface FwkExceptionWriterInterface

Parameters:

code - The event code

See Also:

ErrorNumber

isWarning

public boolean isWarning(int code)

Return true if event code signals a warning.

Specified by:

isWarning in interface FwkExceptionWriterInterface

Parameters:

code - The event code

See Also:

ErrorNumber

isInformation

public boolean isInformation(int code)

Return true if event code signals an informational message.

Specified by:

isInformation in interface FwkExceptionWriterInterface

Parameters:

code - The event code

See Also:

ErrorNumber

isOccurred

public boolean isOccurred()

Indicates whether an event is occurred.

Specified by:

isOccurred in interface FwkExceptionWriterInterface

Returns:

Returns true if an event occurred.

reset

public void reset()

Reset the the current error messages.

Specified by:

reset in interface FwkExceptionWriterInterface

getParams

public java.lang.String getParams()

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

Returns:

The string representation of the parameters of the object.

toString

public java.lang.String toString()

Get the string representation of the object.

Overrides:

toString in class java.lang.Object