org.vishia.mainCmd

Interface MainCmdLogging_ifc

All Superinterfaces:

java.lang.Appendable, java.lang.AutoCloseable, java.io.Closeable, LogMessage

All Known Subinterfaces:

MainCmd_ifc, Report

All Known Implementing Classes:

Bin2Data.CmdLine, C2DataDeps, CheckDeps_Old.Cmdline, CmdHeader2Reflection, Csv2Data.CmdHandler, DocuGen.CmdLine, Filecmd.Cmdline, GenXmlCfgJavaData.CmdLine, GenZbnfJavaData.CmdLine, JZtxtcmd.CmdLine, MainCmd, MainCmdLoggingStream, ReportWrapperLog, SampleCmdLine.CmdLine, Xsltpre.CmdLine, Zbnf2Text.CmdLineText, Zbnf2Xml.CmdLine, Zmake.CmdLine

public interface MainCmdLogging_ifc
extends LogMessage

This interface is the access to output log messages while running an application to check its work.

• One implementor is the MainCmd for command line programming or org.vishia.gral.area9.GralArea9MainCmd for the gral GUI.
• Another implementor independent of any other concept is MainCmdLoggingStream. That class adapts the standard System.out to this interface.
• Using MainCmdLoggingStream and MsgDispatchSystemOutErr one can create messages which can be dispatched to any destinations.

Dieses Interface dient zur Ausgabe von Logmeldungen for kommandozeilenartige Abarbeitung. This interface is usefull for reporting something (logfiles). It should be used in every algorithm routine to support debugging without using an extra debugger. It may help to encircle problems.

Field Summary

Fields

Modifier and Type	Field and Description
static int	anytime Deprecated. use instead Report.error or Report.errorDisplay
static int	eventOrder Deprecated. use instead Report.info or Report.infoDisplay
static int	exitSuccessfull exit value to indicate not at all problems.
static int	exitUserAbort exit value to indicate a unconditional abort of a process.
static int	exitWithArgumentError exit value to indicate a parameter error, that is a programmers error mostly.
static int	exitWithErrors exit value to indicate a error in the own process, at example due to failed data
static int	exitWithFileProblems exit value to indicate a file error, typicall write to a read only file, write to a failed directory, file not exists and others.
static int	exitWithNotes exit value to indicate the user should read something and medidate about.
static int	exitWithWarnings exit value to indicate some warnings, but no fatal errors.
static int	fineEventOrder Deprecated. use instead Report.fineInfo or Report.infoDisplay
static int	interested Deprecated. use instead Report.warning or Report.warningDisplay
static int	version Version and history: 2012-11-10 Hartmut chg: Name of this interface changed from Report to MainCmdLogging_ifc: The identifier Report may be bad understanding, this interface is used as a logging interface.

Fields inherited from interface org.vishia.msgDispatch.LogMessage

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

Method Summary

Modifier and Type	Method and Description
int	getExitErrorLevel() get the errorLevel setted with setExitErrorLevel().
void	openReportfile(java.lang.String sFileReport, boolean bAppendReport)
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	writeStackTrace(java.lang.Exception exc)

Methods inherited from interface org.vishia.msgDispatch.LogMessage

close, flush, flushReport, getReportLevel, getReportLevelFromIdent, isOnline, msgSec, report, report, reportln, reportln, sendMsg, sendMsgTime, sendMsgVaList, setReportLevel, setReportLevelToIdent, timeCurr, timeMsg, writeError, writeError, writeError, writeErrorAdd, writef, writeInfo, writeInfo, writeInfoAdd, writeInfoln, writeWarning, writeWarning, writeWarningAdd

Methods inherited from interface java.lang.Appendable

append, append, append

Field Detail

version

static final int version

Version and history:

• 2012-11-10 Hartmut chg: Name of this interface changed from Report to MainCmdLogging_ifc: The identifier Report may be bad understanding, this interface is used as a logging interface. A report is more a summary presentation. TODO: rename all methods which starts with report.
• 2012-11-10 Hartmut inherits from LogMessage. This interface is used for log, but it contains some more.
• 2012-03-30 Hartmut new #getLogMessageErrorConsole()
• 2011-10-11 Hartmut new setOutputChannels(Appendable, Appendable). All outputs are redirect-able now. Used for output in a graphical text box.
• 2007-12-29 Hartmut some methods from mainCmd_ifc are displaced here. Thus the Report interface is revalued to write some informations also to the display with the capability to control the report levels for that in the implementation.
• 2006-01-07 Hartmut initial revision

See Also:

Constant Field Values

exitUserAbort

static final int exitUserAbort

exit value to indicate a unconditional abort of a process.

See Also:

Constant Field Values

exitWithArgumentError

static final int exitWithArgumentError

exit value to indicate a parameter error, that is a programmers error mostly.

See Also:

Constant Field Values

exitWithFileProblems

static final int exitWithFileProblems

exit value to indicate a file error, typicall write to a read only file, write to a failed directory, file not exists and others.

See Also:

Constant Field Values

exitWithErrors

static final int exitWithErrors

exit value to indicate a error in the own process, at example due to failed data

See Also:

Constant Field Values

exitWithWarnings

static final int exitWithWarnings

exit value to indicate some warnings, but no fatal errors. Warnings may be errors in consequence later.

See Also:

Constant Field Values

exitWithNotes

static final int exitWithNotes

exit value to indicate the user should read something and medidate about.

See Also:

Constant Field Values

exitSuccessfull

static final int exitSuccessfull

exit value to indicate not at all problems.

See Also:

Constant Field Values

anytime

@Deprecated
static final int anytime

Deprecated. use instead Report.error or Report.errorDisplay

older reportlevel

See Also:

Constant Field Values

interested

@Deprecated
static final int interested

Deprecated. use instead Report.warning or Report.warningDisplay

older reportlevel

See Also:

Constant Field Values

eventOrder

@Deprecated
static final int eventOrder

Deprecated. use instead Report.info or Report.infoDisplay

older reportlevel

See Also:

Constant Field Values

fineEventOrder

@Deprecated
static final int fineEventOrder

Deprecated. use instead Report.fineInfo or Report.infoDisplay

older reportlevel

See Also:

Constant Field Values

Method Detail

writeStackTrace

void writeStackTrace(java.lang.Exception exc)

openReportfile

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

Throws:

java.io.FileNotFoundException

setExitErrorLevel

void setExitErrorLevel(int level)

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

Parameters:

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

getExitErrorLevel

int getExitErrorLevel()

get the errorLevel setted with setExitErrorLevel().

setOutputChannels

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

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

Parameters:

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

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