org.vishia.mainCmd

Class MainCmd.LogMessageImplErrConsole

java.lang.Object

org.vishia.msgDispatch.LogMessageBase

org.vishia.mainCmd.MainCmd.LogMessageImplErrConsole

All Implemented Interfaces:

java.lang.Appendable, LogMessage

Enclosing class:

MainCmd

class MainCmd.LogMessageImplErrConsole
extends LogMessageBase

Field Summary

Fields inherited from class org.vishia.msgDispatch.LogMessageBase

nLogLevel

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

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.
boolean	isOnline() Checks whether the message output is available.
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.
java.lang.String	toString()

Methods inherited from class org.vishia.msgDispatch.LogMessageBase

flushReport, getReportLevel, getReportLevelFromIdent, report, report, reportln, reportln, setReportLevel, setReportLevelToIdent, writeError, writeError, writeInfo, writeInfoln, writeWarning

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vishia.msgDispatch.LogMessage

msgSec, timeCurr, timeMsg

Constructor Detail

LogMessageImplErrConsole

LogMessageImplErrConsole()

Method Detail

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.

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.

isOnline

public boolean isOnline()

Description copied from interface: LogMessage

Checks whether the message output is available.

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:

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.

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

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.

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

append

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

Throws:

java.io.IOException

append

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

Throws:

java.io.IOException

append

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

Throws:

java.io.IOException