org.vishia.mainCmd

Class MainCmdLoggingStream

java.lang.Object

org.vishia.mainCmd.MainCmdLoggingStream

All Implemented Interfaces:

java.lang.Appendable, MainCmdLogging_ifc, LogMessage

public class MainCmdLoggingStream
extends java.lang.Object
implements MainCmdLogging_ifc

This class is a mainCmd logging output with adequate features as the MainCmd class, but independent of that. It is intent to use if the logging features are other than in the main routine given, or if MainCmd is not used for the originally invocation of a Java program. Especially it can be used for logging output inside a JZtxtcmdExecuter for some special routines.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Appendable	app
private java.text.SimpleDateFormat	dateFormat
protected java.io.OutputStream	out Stream to output all logging information.
private java.io.PrintStream	printStream Created on demand.
private java.io.PrintWriter	printWriter Created on demand.
(package private) int	reportLevel This variable determines which level is output.
private static java.lang.String	sLeft
static java.lang.String	sVersion Version, history and license.
private java.lang.StringBuilder	u

Fields inherited from interface org.vishia.mainCmd.MainCmdLogging_ifc

anytime, eventOrder, exitSuccessfull, exitUserAbort, exitWithArgumentError, exitWithErrors, exitWithFileProblems, exitWithNotes, exitWithWarnings, fineEventOrder, interested, version

Fields inherited from interface org.vishia.msgDispatch.LogMessage

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

Constructor Summary

Constructors

Constructor and Description
MainCmdLoggingStream(java.io.OutputStream out) Create with given output stream, or empty.
MainCmdLoggingStream(java.io.OutputStream out, int reportLevel) Create with given output stream, or empty.
MainCmdLoggingStream(java.lang.String sDateFormat, java.lang.Appendable app) Create with given Appendable and dateformat.
MainCmdLoggingStream(java.lang.String sDateFormat, java.lang.Appendable app, int reportLevel) Create with given output stream, or empty.

Method Summary

Modifier and Type	Method and Description
java.lang.Appendable	append(char c)
java.lang.Appendable	append(java.lang.CharSequence csq)
java.lang.Appendable	append(java.lang.CharSequence csq, int start, int end)
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() Returns 0
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(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
boolean	sendMsg(int identNumber, java.lang.CharSequence text, java.lang.Object... args) Sends a message.
boolean	sendMsgTime(int identNumber, OS_TimeStamp creationTime, java.lang.CharSequence text, java.lang.Object... args) Sends a message.
boolean	sendMsgVaList(int identNumber, OS_TimeStamp creationTime, java.lang.CharSequence 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.
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.
(package private) void	writeBuffer()
void	writeError(java.lang.CharSequence 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.CharSequence sInfo) Appends an info to the end of the previous info, @see #writeInfoln.
void	writeInfoln(java.lang.CharSequence sInfo) Writes an info line.
(package private) void	writeln(int level, int nLeftMargin, java.lang.CharSequence ss)
void	writeStackTrace(java.lang.Exception exc)
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

msgSec, timeCurr, timeMsg

Field Detail

sVersion

public static final java.lang.String sVersion

Version, history and license.

• 2013-10-19 Hartmut new: Supports an Appendable now alternatively to the PrintStream as aggregation for output. More flexibility, able to use for other output channels than System.out.
• 2013-10-19 Hartmut created as bridge between the MainCmdLogging_ifc and any class which does not have an association to the MainCmd.

Copyright/Copyleft:
For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but doesn't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you intent to use this source without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

out

protected java.io.OutputStream out

Stream to output all logging information.

app

protected final java.lang.Appendable app

u

private final java.lang.StringBuilder u

dateFormat

private final java.text.SimpleDateFormat dateFormat

sLeft

private static java.lang.String sLeft

printWriter

private java.io.PrintWriter printWriter

Created on demand.

printStream

private java.io.PrintStream printStream

Created on demand.

reportLevel

int reportLevel

This variable determines which level is output. See LogMessage.fineDebug etc.

Constructor Detail

MainCmdLoggingStream

public MainCmdLoggingStream(java.io.OutputStream out)

Create with given output stream, or empty.

Parameters:

out - may be null, use openReportfile(String, boolean) than.

MainCmdLoggingStream

public MainCmdLoggingStream(java.io.OutputStream out,
                            int reportLevel)

Create with given output stream, or empty.

Parameters:

out - may be null, use openReportfile(String, boolean) than.

MainCmdLoggingStream

public MainCmdLoggingStream(java.lang.String sDateFormat,
                            java.lang.Appendable app)

Create with given Appendable and dateformat. Note: The sDateFormat is the first parameter to distinquish a System.out between Appendable and PrintStream.

Parameters:

sDateFormat - see simpleDateFormatter, use "MMM-dd HH:mm:ss.SSS: " for example.

app - may be null, use openReportfile(String, boolean) than.

MainCmdLoggingStream

public MainCmdLoggingStream(java.lang.String sDateFormat,
                            java.lang.Appendable app,
                            int reportLevel)

Create with given output stream, or empty. Note: The sDateFormat is the first parameter to distinquish a System.out between Appendable and PrintStream.

Parameters:

sDateFormat - see simpleDateFormatter, use "MMM-dd HH:mm:ss.SSS: " for example.

app - may be null, use openReportfile(String, boolean) than.

Method Detail

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

getExitErrorLevel

public int getExitErrorLevel()

Returns 0

Specified by:

getExitErrorLevel in interface MainCmdLogging_ifc

See Also:

MainCmdLogging_ifc.getExitErrorLevel()

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.

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.

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

Description copied from interface: LogMessage

report inside a line

Specified by:

report in interface LogMessage

writeBuffer

void writeBuffer()

writeln

void writeln(int level,
             int nLeftMargin,
             java.lang.CharSequence ss)

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

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.

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.

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.

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

setReportLevel

public int setReportLevel(int newLevel)

Description copied from interface: LogMessage

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

Specified by:

setReportLevel in interface LogMessage

Returns:

the current level, usefull to restore it.

writeError

public void writeError(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:

writeError in interface LogMessage

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: 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

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

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.

writeStackTrace

public void writeStackTrace(java.lang.Exception exc)

Specified by:

writeStackTrace in interface MainCmdLogging_ifc

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

close

public void close()

Description copied from interface: LogMessage

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

Description copied from interface: LogMessage

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

Description copied from interface: LogMessage

Checks whether the message output is available.

Specified by:

isOnline in interface LogMessage

sendMsg

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

Description copied from interface: LogMessage

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:

true if the message will be dispatched, false if it is suppressed

sendMsgTime

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

Description copied from interface: LogMessage

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:

true if the message will be dispatched, false if it is suppressed

sendMsgVaList

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

Description copied from interface: LogMessage

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

text - The text of the message: Hint for Java2C: This is a StringJc, not a simple char const*. That is necessary because the String may be replaced.

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.

append

public java.lang.Appendable append(java.lang.CharSequence csq)
                            throws java.io.IOException

Specified by:

append in interface java.lang.Appendable

Throws:

java.io.IOException

append

public java.lang.Appendable append(java.lang.CharSequence csq,
                                   int start,
                                   int end)
                            throws java.io.IOException

Specified by:

append in interface java.lang.Appendable

Throws:

java.io.IOException

append

public java.lang.Appendable append(char c)
                            throws java.io.IOException

Specified by:

append in interface java.lang.Appendable

Throws:

java.io.IOException