org.vishia.msgDispatch

Class MsgDispatchSystemOutErr

java.lang.Object

org.vishia.msgDispatch.MsgDispatchSystemOutErr

public final class MsgDispatchSystemOutErr
extends java.lang.Object

This class replaces the System.out and System.err with 2 inputs which creates a LogMessage and dispatch it with the Message Dispatcher. Without any other effort both outputs will be dispatch to the originally System.out and System.err output, but with additional time stamp and identification number.

The messages can be redirected and prevented using the MsgDispatcher capability.

Note that this class is a simple variant for redirection. It is limited

Field Summary

Fields

Modifier and Type	Field and Description
LogMessageStream	cmdlineErr The output channels to console.
LogMessageStream	cmdlineOut The output channels to console.
LogMessageFile	fileOutput It is null when #MsgDispatchSystemOutErr(String) was called with null.
static int	ixMsgOutputFile Indices to the output channels.
static int	ixMsgOutputStdErr Indices to the output channels.
static int	ixMsgOutputStdOut Indices to the output channels.
MsgDispatcher	msgDispatcher The message dispatcher
MsgPrintStream	printErr The converter from any output to a message.
MsgPrintStream	printOut The converter from any output to a message.
static MsgDispatchSystemOutErr	singleton
private java.util.TimeZone	timeZoneForFile
static int	version Version, history and license.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MsgDispatchSystemOutErr(java.lang.String msgFiles, int identStartOut, int identStartErr, int sizeNoGroup, int sizeGroup) Initializes the redirection of System.out and System.err

Method Summary

Modifier and Type	Method and Description
static MsgDispatchSystemOutErr	create(java.lang.String msgFiles, int identStartOut, int identStartErr, int sizeNoGroup, int sizeGroup) Creates a static instance to redirect System.err and System.out

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final int version

Version, history and license.

• 2014-12-19 Hartmut chg: moved from srcJava_vishiaRun to this component srcJava_vishiaBase because it is a base concept which does not use any specials with communication etc. Creating a new archive.
• 2013-01-26 Hartmut fine tuning
• 2012-01-07 Hartmut creation, to support a simple usage of MsgPrintStream to redirect System.out and System.err.

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

ixMsgOutputStdOut

public static final int ixMsgOutputStdOut

Indices to the output channels.

See Also:

Constant Field Values

ixMsgOutputStdErr

public static final int ixMsgOutputStdErr

Indices to the output channels.

See Also:

Constant Field Values

ixMsgOutputFile

public static final int ixMsgOutputFile

Indices to the output channels.

See Also:

Constant Field Values

printOut

public final MsgPrintStream printOut

The converter from any output to a message. Note that you can invoke MsgPrintStream.setMsgGroupIdent(String, int, int) to manipulate the building of the ident numbers.

printErr

public final MsgPrintStream printErr

The converter from any output to a message. Note that you can invoke MsgPrintStream.setMsgGroupIdent(String, int, int) to manipulate the building of the ident numbers.

msgDispatcher

public final MsgDispatcher msgDispatcher

The message dispatcher

fileOutput

public final LogMessageFile fileOutput

It is null when #MsgDispatchSystemOutErr(String) was called with null.

timeZoneForFile

private final java.util.TimeZone timeZoneForFile

cmdlineOut

public final LogMessageStream cmdlineOut

The output channels to console.

cmdlineErr

public final LogMessageStream cmdlineErr

The output channels to console.

singleton

public static MsgDispatchSystemOutErr singleton

Constructor Detail

MsgDispatchSystemOutErr

private MsgDispatchSystemOutErr(java.lang.String msgFiles,
                                int identStartOut,
                                int identStartErr,
                                int sizeNoGroup,
                                int sizeGroup)

Initializes the redirection of System.out and System.err

Parameters:

msgFiles - A file path. If not null, then all messages will be written to the file additionally to the console. Note that the MsgDispatcher can be configured after this constructor to modify the outputs.

Method Detail

create

public static MsgDispatchSystemOutErr create(java.lang.String msgFiles,
                                             int identStartOut,
                                             int identStartErr,
                                             int sizeNoGroup,
                                             int sizeGroup)

Creates a static instance to redirect System.err and System.out

Parameters:

msgFiles - A file path. If not null, then all messages will be written to the file additionally to the console. Note that the MsgDispatcher can be configured after this constructor to modify the outputs.

Returns:

The instance, able to get with singleton too.