com.highqsoft.fwk.exception

Class FwkFileWriter

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.exception.FwkFileWriter

All Implemented Interfaces:

FwkExceptionWriterInterface, FwkInterface, java.io.Serializable

public class FwkFileWriter
extends Fwk
implements FwkExceptionWriterInterface, FwkInterface

The FwkFileWriter writes the exception to a file.

Inside the initializer the class create a file generated by the directory comming fom the request of FwkContainer.getUserDirectory() and the name com-highqsoft-error.log. This is ~/properties/com-highqsoft-error.log by default.

Since:

$Date: 2017/04/06 13:29:06 $

Version:

$Revision: 1.14 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
FwkFileWriter() The private constructor.

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.
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 could initialize the library.
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 occured.
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() Set there is no error occured.
void	setDefaults() This method sets all internal states to the default.
java.lang.String	toString() This function returns a string containing the string representation of the object.

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

Constructor Detail

FwkFileWriter

public FwkFileWriter()

The private constructor.

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

isAlive

public boolean isAlive()

Returns whether the writer could initialize the library.

Specified by:

isAlive in interface FwkExceptionWriterInterface

Returns:

True if the writer could initialize the library.

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.

Specified by:

init in interface FwkExceptionWriterInterface

Parameters:

name - Name of program.

version - Version of the program.

args - Main program parameters.

put

public void put(FwkExceptionInterface exception)

Put an event to the event logger. When more than 10 (MAX_ERROR)identical events occured 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 occured and the flag is set.

Specified by:

put in interface FwkExceptionWriterInterface

Parameters:

exception - The FwkException to be written.

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)

Put an event to the event logger. When more than 10 (MAX_ERROR)identical events occured 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 occured and the flag is set.

Specified by:

put in interface FwkExceptionWriterInterface

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.

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 occured.

Specified by:

isOccurred in interface FwkExceptionWriterInterface

Returns:

Returns true if an event occured.

reset

public void reset()

Set there is no error occured. If an error occured it is automatic set.

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.

See Also:

toString

toString

public java.lang.String toString()

This function returns a string containing the string representation of the object. Use the following syntax to enable the creation of the object.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of the object.

See Also:

getParams

setDefaults

public void setDefaults()

This method sets all internal states to the default.