org.vishia.mainCmd

Class ReportWrapperLog

java.lang.Object

org.vishia.mainCmd.ReportWrapperLog

All Implemented Interfaces:

MainCmdLogging_ifc, Report, LogMessage

public class ReportWrapperLog
extends java.lang.Object
implements Report

This class adapts a Report output to the LogMessage or Message Dispatcher.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) LogMessage	log

Fields inherited from interface org.vishia.mainCmd.MainCmdLogging_ifc

anytime, debug, error, eventOrder, exitSuccessfull, exitUserAbort, exitWithArgumentError, exitWithErrors, exitWithFileProblems, exitWithNotes, exitWithWarnings, fineDebug, fineEventOrder, fineInfo, info, interested, mNeverOutputToDisplay, mReportLevel, version, warning

Fields inherited from interface org.vishia.msgDispatch.LogMessage

sVersion

Constructor Summary

Constructors

Constructor and Description
ReportWrapperLog(LogMessage log)

Method Summary

Modifier and Type	Method and Description
void	close() A call of this method closes the devices, which processed the message.
void	flush() A call of this method causes an activating of transmission of all messages since last flush.
void	flushReport() Writes the content in the physical medium.
int	getExitErrorLevel() get the errorLevel setted with setExitErrorLevel().
LogMessage	getLogMessageErrorConsole() Gets a LogMessage error output.
LogMessage	getLogMessageOutputConsole() Gets a LogMessage output.
LogMessage	getLogMessageOutputFile() Gets a LogMessage output.
int	getReportLevel() access to the level of report.
int	getReportLevelFromIdent(int ident) gets the associated report level to a report identifier.
boolean	isOnline() Checks whether the message output is available.
void	openReportfile(java.lang.String sFileReport, boolean bAppendReport)
void	report(int nLevel, java.lang.String string) report inside a line
void	report(java.lang.String sText, java.lang.Throwable exception) report of a excpetion (in a new line)
void	reportln(int nLevel, int nLeftMargin, java.lang.String string) report begins at a new a line with left margin
void	reportln(int nLevel, java.lang.String string) report begins at a new a line
boolean	sendMsg(int identNumber, java.lang.String text, java.lang.Object... args) Sends a message.
boolean	sendMsgTime(int identNumber, OS_TimeStamp creationTime, java.lang.String text, java.lang.Object... args) Sends a message.
boolean	sendMsgVaList(int identNumber, OS_TimeStamp creationTime, java.lang.String text, Va_list args) Sends a message.
void	setExitErrorLevel(int level) set the exitErrorLevel of the maximum of given level of every call.
void	setOutputChannels(java.lang.Appendable outP, java.lang.Appendable errP) Sets destinations for output and error output.
void	setReportLevelToIdent(int ident, int nLevelActive) Sets a dedicated level number to the known output priorities.
void	writeError(java.lang.String sError) Writes an error line.
void	writeError(java.lang.String sError, java.lang.Throwable exception) Writes an error line caused by an exception.
void	writeInfo(java.lang.String sInfo) Appends an info to the end of the previous info, @see #writeInfoln.
void	writeInfoln(java.lang.String sInfo) Writes an info line.
void	writeStackTrace(java.lang.Exception exc)
void	writeWarning(java.lang.String sError) Writes an error line.

Methods inherited from class java.lang.Object

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

Field Detail

log

final LogMessage log

Constructor Detail

ReportWrapperLog

public ReportWrapperLog(LogMessage log)

Method Detail

flushReport

public void flushReport()

Description copied from interface: MainCmdLogging_ifc

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 MainCmdLogging_ifc

getExitErrorLevel

public int getExitErrorLevel()

Description copied from interface: MainCmdLogging_ifc

get the errorLevel setted with setExitErrorLevel().

Specified by:

getExitErrorLevel in interface MainCmdLogging_ifc

getLogMessageOutputConsole

public LogMessage getLogMessageOutputConsole()

Description copied from interface: Report

Gets a LogMessage output.

Specified by:

getLogMessageOutputConsole in interface Report

Returns:

never null.

getLogMessageErrorConsole

public LogMessage getLogMessageErrorConsole()

Description copied from interface: Report

Gets a LogMessage error output.

Specified by:

getLogMessageErrorConsole in interface Report

Returns:

never null.

getLogMessageOutputFile

public LogMessage getLogMessageOutputFile()

Description copied from interface: Report

Gets a LogMessage output.

Specified by:

getLogMessageOutputFile in interface Report

Returns:

never null.

getReportLevel

public int getReportLevel()

Description copied from interface: MainCmdLogging_ifc

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 MainCmdLogging_ifc

Returns:

The report level, defined by user invoking.

getReportLevelFromIdent

public int getReportLevelFromIdent(int ident)

Description copied from interface: MainCmdLogging_ifc

gets the associated report level to a report identifier.

Specified by:

getReportLevelFromIdent in interface MainCmdLogging_ifc

Parameters:

ident - The identifier.

Returns:

the level.

openReportfile

public void openReportfile(java.lang.String sFileReport,
                           boolean bAppendReport)
                    throws java.io.FileNotFoundException

Specified by:

openReportfile in interface MainCmdLogging_ifc

Throws:

java.io.FileNotFoundException

report

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

Description copied from interface: MainCmdLogging_ifc

report inside a line

Specified by:

report in interface MainCmdLogging_ifc

report

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

Description copied from interface: MainCmdLogging_ifc

report of a excpetion (in a new line)

Specified by:

report in interface MainCmdLogging_ifc

reportln

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

Description copied from interface: MainCmdLogging_ifc

report begins at a new a line with left margin

Specified by:

reportln in interface MainCmdLogging_ifc

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.String string)

Description copied from interface: MainCmdLogging_ifc

report begins at a new a line

Specified by:

reportln in interface MainCmdLogging_ifc

Parameters:

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

string - String to write.

setExitErrorLevel

public void setExitErrorLevel(int level)

Description copied from interface: MainCmdLogging_ifc

set the exitErrorLevel of the maximum of given level of every call.

Specified by:

setExitErrorLevel in interface MainCmdLogging_ifc

Parameters:

level - Errorlevel how defined in Report, 0 is the lowest level (successfull), >0 is worse.

setReportLevelToIdent

public void setReportLevelToIdent(int ident,
                                  int nLevelActive)

Description copied from interface: MainCmdLogging_ifc

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 MainCmdLogging_ifc

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

writeError

public void writeError(java.lang.String sError)

Description copied from interface: MainCmdLogging_ifc

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:

writeError in interface MainCmdLogging_ifc

Parameters:

sError - 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);

writeError

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

Description copied from interface: MainCmdLogging_ifc

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 MainCmdLogging_ifc

Parameters:

sError - 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);

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

writeInfo

public void writeInfo(java.lang.String sInfo)

Description copied from interface: MainCmdLogging_ifc

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

Specified by:

writeInfo in interface MainCmdLogging_ifc

Parameters:

sInfo - String to be written.

writeInfoln

public void writeInfoln(java.lang.String sInfo)

Description copied from interface: MainCmdLogging_ifc

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 MainCmdLogging_ifc

Parameters:

sInfo - String to be written.

writeWarning

public void writeWarning(java.lang.String sError)

Description copied from interface: MainCmdLogging_ifc

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 MainCmdLogging_ifc

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);

writeStackTrace

public void writeStackTrace(java.lang.Exception exc)

Specified by:

writeStackTrace in interface MainCmdLogging_ifc

setOutputChannels

public void setOutputChannels(java.lang.Appendable outP,
                              java.lang.Appendable errP)

Description copied from interface: MainCmdLogging_ifc

Sets destinations for output and error output. This method may allow to redirect output and error.

Specified by:

setOutputChannels in interface MainCmdLogging_ifc

Parameters:

outP - Destination for output. If null, current output isn't change.

errP - Destination for error output. If null, current output isn't change.

sendMsg

public boolean sendMsg(int identNumber,
                       java.lang.String text,
                       java.lang.Object... args)

Sends a message. The timestamp of the message is build with the system time. All other parameter are identically see #sendMsg(int, OS_TimeStamp, String, Object...).

Specified by:

sendMsg in interface LogMessage

Parameters:

identNumber - of the message. If it is negative, it is the same message as positive number, but with information 'going state', where the positive number is 'coming state'.

text - The text representation of the message, format string, see java.lang.String.format(..).

args - 0, 1 or more arguments of any type. The interpretation of the arguments is controlled by param text.

Returns:

TODO

sendMsgTime

public boolean sendMsgTime(int identNumber,
                           OS_TimeStamp creationTime,
                           java.lang.String text,
                           java.lang.Object... args)

Sends a message.

Specified by:

sendMsgTime in interface LogMessage

Parameters:

identNumber - of the message. If it is negative, it is the same message as positive number, but with information 'going state', where the positive number is 'coming state'.

creationTime - absolute time stamp. @Java2C=perValue.

text - The text representation of the message, format string, see java.lang.String.format(..).

args - 0, 1 or more arguments of any type. The interpretation of the arguments is controlled by param text.

Returns:

TODO

sendMsgVaList

public boolean sendMsgVaList(int identNumber,
                             OS_TimeStamp creationTime,
                             java.lang.String text,
                             Va_list args)

Sends a message. The functionality and the calling parameters are identically with #sendMsg(int, OS_TimeStamp, String, Object...), but the parameter args is varied:

Specified by:

sendMsgVaList in interface LogMessage

Parameters:

identNumber -

creationTime -

text -

typeArgs - Type chars, ZCBSIJFD for boolean, char, byte, short, int, long, float double.

args - Reference to a buffer which contains the values for a variable argument list.
In C implementation it is a reference either to the stack, or to a buffer elsewhere, but the reference type is appropriate to provide the values in stack for calling routines with variable argument list such as vprintf(buffer, text, args). The referenced instance shouldn't accepted as persistent outside processing time of the called routine. Therefore stack content is able to provide.
In Java it is a special class wrapping a Object[] tantamount to a Object... as variable argument list. Using of this wrapper class is only a concession to C-programming, because in Java an Object[] would adequate.

Returns:

true than okay. It is possible, that a destination for dispatching is not available yet. Than the routine returns false. That is for special outputs of message dispatcher. Normally the user shouldn't realize false here and react anywise. If a message isn't able to transport, it is not visible in the creating thread. It is possible that a message is lost anywhere in transportation way. In Generally, to secure a complex systems functionality, any timeouts, repeats and backup strategies are necessary in the supervise software above sending a single message.

close

public void close()

A call of this method closes the devices, which processed the message. It is abstract. It depends from the kind of device, what close mean. If the device is a log file writer it should be clearly. close may mean, the processing of messages is finite temporary. An open occurs automatically, if a new message is dispatched.

Specified by:

close in interface LogMessage

flush

public void flush()

A call of this method causes an activating of transmission of all messages since last flush. It is abstract. It depends from the kind of device, what flush mean. If the device is a log file writer it should be clearly. flush may mean, the processing of messages is ready to transmit yet.

Specified by:

flush in interface LogMessage

isOnline

public boolean isOnline()

Checks whether the message output is available.

Specified by:

isOnline in interface LogMessage