org.vishia.msgDispatch

Class LogMessageBase

java.lang.Object

org.vishia.msgDispatch.LogMessageBase

All Implemented Interfaces:

java.lang.Appendable, LogMessage

Direct Known Subclasses:

LogMessageFile, LogMessageStream, MainCmd.LogMessageImplConsole, MainCmd.LogMessageImplErrConsole, MainCmd.LogMessageImplFile, MsgDispatcherCore

public abstract class LogMessageBase
extends java.lang.Object
implements LogMessage

This class implements some operations of LogMessage which are independent of the particular implementation. It is used via extends instead immediately implements the LogMessage for the particular derived classes.

Since:

2022-10-00

Field Summary

Fields

Modifier and Type	Field and Description
int	nLogLevel All reports with a level less than or equal this level will be reported.

Fields inherited from interface org.vishia.msgDispatch.LogMessage

dateFormat, debug, error, fineDebug, fineInfo, info, minSecondsFormat, mNeverOutputToDisplay, mReportLevel, sVersion, warning

Constructor Summary

Constructors

Constructor and Description
LogMessageBase()

Method Summary

Modifier and Type	Method and Description
void	flushReport() Writes the content in the physical medium.
int	getReportLevel() access to the level of report.
int	getReportLevelFromIdent(int ident) gets the associated report level to a report identifier.
void	report(java.lang.CharSequence sText, java.lang.Throwable exception) report of a excpetion (in a new line)
void	report(int nLevel, java.lang.CharSequence string) report inside a line
void	reportln(int nLevel, java.lang.CharSequence string) report begins at a new a line
void	reportln(int nLevel, int nLeftMargin, java.lang.CharSequence string) report begins at a new a line with left margin
int	setReportLevel(int newLevel) Set another level inside programming.
void	setReportLevelToIdent(int ident, int nLevelActive) Sets a dedicated level number to the known output priorities.
void	writeError(java.lang.CharSequence text) Implemented only as wrapper around simple append output.
void	writeError(java.lang.String sError, java.lang.Throwable exc) Writes an error line caused by an exception.
void	writeInfo(java.lang.CharSequence sInfo) Appends an info to the end of the previous info, @see #writeInfoln.
void	writeInfoln(java.lang.CharSequence sInfo) Writes an info line.
void	writeWarning(java.lang.CharSequence sError) Writes an error line.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vishia.msgDispatch.LogMessage

close, flush, isOnline, msgSec, sendMsg, sendMsgTime, sendMsgVaList, timeCurr, timeMsg

Methods inherited from interface java.lang.Appendable

append, append, append

Field Detail

nLogLevel

public int nLogLevel

All reports with a level less than or equal this level will be reported. Other report calls has non effect.

Constructor Detail

LogMessageBase

public LogMessageBase()

Method Detail

writeError

public void writeError(java.lang.CharSequence text)

Implemented only as wrapper around simple append output. It is without throws, simple usage. May be adapted to message output in derived classes

Specified by:

writeError in interface LogMessage

Parameters:

text - The error text, it should be without such hot spot words line "!!!ERROR!!!", because the distinction in display should be done by the implementation of this method. A good sample is writeErrorln("cannot create file: " + sFileName);

writeInfoln

public void writeInfoln(java.lang.CharSequence sInfo)

Description copied from interface: LogMessage

Writes an info line. This method should be used instead a directly write via System.out.println(...). The using of System.out writes the output directly on console window of the command line, but in general, the user mostly don't want to write to the console, he only will give an information out. In a GUI-application, this information can be displayed in a status line or scrolling output window. It may also be possible to write the information in a file additional. The implementation of this method writes the output in the conformed way to the application frame.
Before output, the previous line is terminated by a newline, or a status line will be cleared.

Specified by:

writeInfoln in interface LogMessage

Parameters:

sInfo - String to be written.

writeInfo

public void writeInfo(java.lang.CharSequence sInfo)

Description copied from interface: LogMessage

Appends an info to the end of the previous info, @see #writeInfoln.

Specified by:

writeInfo in interface LogMessage

Parameters:

sInfo - String to be written.

writeWarning

public void writeWarning(java.lang.CharSequence sError)

Description copied from interface: LogMessage

Writes an error line. This method should be used instead a directly write via System.err.println(...). The using of System.err writes the output directly on console window of the command line, but in general, the user mostly don't want to write to the console, he will give an information out. In a GUI-application, this information can be displayed in a status line or scrolling output window. It may also be possible to write the information in a file additional. The implementation of this method writes the output in the conformed way to the application frame.
Before output, the previous line is terminated by a newline, or a status line will be cleared.

Specified by:

writeWarning in interface LogMessage

Parameters:

sError - The error text, it should be without such hot spot words line "!!!WARNING!!!", because the distinction in display should be done by the implementation of this method. A good sample is writeErrorln("file is empty: " + sFileName);

writeError

public void writeError(java.lang.String sError,
                       java.lang.Throwable exc)

Description copied from interface: LogMessage

Writes an error line caused by an exception. This method should be used instead a directly write via System.err.println(...) and by catching an exception. The using of System.err writes the output directly on console window of the command line, but in general, the user mostly don't want to write to the console, he will give an information out. In a GUI-application, this information can be displayed in a status line or scrolling output window. It may also be possible to write the information in a file additional. The implementation of this method writes the output in the conformed way to the application frame.
Before output, the previous line is terminated by a newline, or a status line will be cleared.

Specified by:

writeError in interface LogMessage

exc - The catched Exception. The getMessage()-part of the exception is written after sError. The stacktrace of the exception is written to report.

report

public void report(int nLevel,
                   java.lang.CharSequence string)

Description copied from interface: LogMessage

report inside a line

Specified by:

report in interface LogMessage

reportln

public void reportln(int nLevel,
                     int nLeftMargin,
                     java.lang.CharSequence string)

Description copied from interface: LogMessage

report begins at a new a line with left margin

Specified by:

reportln in interface LogMessage

Parameters:

nLevel - write the report only if the demand level is greater or equal.

nLeftMargin - determins a left margin. First a new line is outputted, followed by '*' and spaces.

string - String to write.

reportln

public void reportln(int nLevel,
                     java.lang.CharSequence string)

Description copied from interface: LogMessage

report begins at a new a line

Specified by:

reportln in interface LogMessage

Parameters:

nLevel - write the report only if the demand level is greater or equal.

string - String to write.

report

public void report(java.lang.CharSequence sText,
                   java.lang.Throwable exception)

Description copied from interface: LogMessage

report of a excpetion (in a new line)

Specified by:

report in interface LogMessage

setReportLevel

public int setReportLevel(int newLevel)

Set another level inside programming. It is advisable to restore the old level after the designated operation.

Specified by:

setReportLevel in interface LogMessage

Parameters:

newLevel - The level to be set, use one of the defines MainCmdLogging_ifc.info to MainCmdLogging_ifc.fineDebug

Returns:

the current level, usefull to restore it.

getReportLevel

public int getReportLevel()

Description copied from interface: LogMessage

access to the level of report. With the knowledge of the maximal reportlevel the user can decide on some actions in context of report.

Specified by:

getReportLevel in interface LogMessage

Returns:

The report level, defined by user invoking.

flushReport

public void flushReport()

Description copied from interface: LogMessage

Writes the content in the physical medium. The implementation of flush is in the best way as possible. It depends on the possibilities of the output medium.

Specified by:

flushReport in interface LogMessage

setReportLevelToIdent

public void setReportLevelToIdent(int ident,
                                  int nLevelActive)

Description copied from interface: LogMessage

Sets a dedicated level number to the known output priorities. This method helps to define several levels to dispatch it.

Specified by:

setReportLevelToIdent in interface LogMessage

nLevelActive - Ones of the known priotity levels Report.error to Report.fineDebug.
Example of using:

   class MyModule
   { /**Define module-specific numbers to identify a level. 
      * The numbers should be define regarding a band of numbers in the application.
      * /  
     static final int myReportLevel1 = 3500, myReportLevel2=3501; 
     
     void init()
     { setLevelActive(myReportLevel1, Report.info);  //This reports should be outputted always
       setLevelActive(myReportLevel2, Report.debug); //This reports are debug infos.
     }
     
     void processAnything()
     { report.reportln( myReportLevel1, "InfoText"); //It depends on the report level settings 
       report.reportln( myReportLevel2, "DebugText");//whether it is outputed or not. 
     }  
 

getReportLevelFromIdent

public int getReportLevelFromIdent(int ident)

Description copied from interface: LogMessage

gets the associated report level to a report identifier.

Specified by:

getReportLevelFromIdent in interface LogMessage

Parameters:

ident - The identifier.

Returns:

the level.