org.vishia.msgDispatch

Class MsgPrintStream

java.lang.Object

org.vishia.msgDispatch.MsgPrintStream

All Implemented Interfaces:

MsgPrintStream_ifc

public class MsgPrintStream
extends java.lang.Object
implements MsgPrintStream_ifc

This class adapts an PrintStream such as System.err to the LogMessage-System. The first part of the message string till a semicolon or colon is used to build a number, whereby a number range (group) is determined by the left division before a " - " or "-". Anytime if a message with the same first part is sent, the same number will be associated. Only at first time a number will be created.

One should write all outputs in the form:

 System.err.println("Source of message - short message; some additional " + information);
 

This is a form which may be proper outside this class too. One should inform about the source of the message, then what's happen, then some more information. If one uses a semicolon as separator, it's able to present such messages for example in an Excel sheet.

The ident number of the message allows especially the redirection of outputs to System.err or System.out to the message system: The LogMessage interface needs a number to identify the message, the MsgDispatcher needs numbers to dispatch. If any identification string is used the first time, a number is created automatically. If the same start text is used a second one (especially if an output was invoked a second time), the start text is identified and the same number is used. One can sort messages with that number.

This first part is divide into 2 divisions: before and after a " - " to build message number ranges. One should write " - " (with spaces left and right). This is used as separator. Only if a " - " is not found, a simple "-" character is used as separator. If no separator is found, it is a non grouped message. One should use groups because Examples for separation first division (group):

 "Source - second division"
 "Source-specification - second division"
 "Source-second division"
 

the message dispatcher can deal with ranges.

It is possible to preset the number association to the first-part-texts. Use setMsgIdents(MsgText_ifc). This can be used in conclusion with MsgConfig.setMsgDispaching(MsgDispatcher, String) to set the dispatching of this message.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	MsgPrintStream.GroupIdent
private class	MsgPrintStream.PrintStreamAdapter

Field Summary

Fields

Modifier and Type	Field and Description
private int	identGroupLast
private int	identLast
private java.util.Map<java.lang.String,MsgPrintStream.GroupIdent>	idxGroupIdent
private java.util.Map<java.lang.String,java.lang.Integer>	idxIdent Map of all Strings to an message ident number.
private LogMessage	logOut
private java.util.concurrent.atomic.AtomicInteger	nextGroupIdent
private java.util.concurrent.atomic.AtomicInteger	nextIdent
protected java.io.OutputStream	outStream This class is used for all outputs to the MsgPrintStream.PrintStreamAdapter which are not gathered by the overridden methods of PrintStream.
static int	version Version, history and license.
private int	zGroup

Constructor Summary

Constructors

Constructor and Description
MsgPrintStream(LogMessage logOut, int identStart, int sizeNoGroup, int sizeGroup) Constructs.

Method Summary

Modifier and Type	Method and Description
protected void	convertToMsg(java.lang.String pre, java.lang.CharSequence identString, java.lang.Object... args)
private MsgPrintStream.GroupIdent	getMsgGroupIdent(java.lang.String pre, java.lang.String msg)
java.io.PrintStream	getPrintStreamLog(java.lang.String pre) Returns the PrintStream which converts and redirects the output String to the given LogMessage output.
boolean	setMsgGroupIdent(java.lang.String sIdent, int nrStart, int nrLast) Creates a group with the given text and the given ident number range.
void	setMsgIdents(MsgText_ifc src) Sets all associations between a message identification text to its ident number or to its number range.

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-05-29 Hartmut chg: override MsgPrintStream.PrintStreamAdapter.append(CharSequence) because it is invoked in the PrintStream and should overridden to output the text. Note that one of the core methods of PrintStream is write(...) but that is private.
• 2013-09-14 Hartmut chg: override println(Object) without them the superclass calls print(Object.toString) + "\n". The newline buffer mechanism had not worked without them.
• 2013-09-14 Hartmut chg: The MsgPrintStream.PrintStreamAdapter.print(String) does not dispatch the text directly but does append it to an internal line buffer till an newline "\n" is detected. It is because the super method append(CharSequence) calls this method. A PrintStream can be referred as Appendable and the output can be done with ref.append("start - string;").append(parameter).append("\n") too!
• 2013-01-26 Hartmut new: setMsgGroupIdent(String, int, int) to handle message dispatching with known or probably texts.
• 2013-01-26 Hartmut chg: Limitation of ident numbers to its range.
• 2012-07-01 chg Hartmut: Now doesn't change System.err, but supplies #getPrintStreamLog() to set System.setOut(...) and System.setErr(...).
• 2011-10-00 Hartmut created

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

logOut

private final LogMessage logOut

nextIdent

private final java.util.concurrent.atomic.AtomicInteger nextIdent

identLast

private final int identLast

nextGroupIdent

private final java.util.concurrent.atomic.AtomicInteger nextGroupIdent

identGroupLast

private final int identGroupLast

zGroup

private final int zGroup

idxIdent

private final java.util.Map<java.lang.String,java.lang.Integer> idxIdent

Map of all Strings to an message ident number.

idxGroupIdent

private final java.util.Map<java.lang.String,MsgPrintStream.GroupIdent> idxGroupIdent

outStream

protected final java.io.OutputStream outStream

This class is used for all outputs to the MsgPrintStream.PrintStreamAdapter which are not gathered by the overridden methods of PrintStream. There should not be such methods. Therefore the write-methods is not called. But the outStream should not be empty.

Constructor Detail

MsgPrintStream

public MsgPrintStream(LogMessage logOut,
                      int identStart,
                      int sizeNoGroup,
                      int sizeGroup)

Constructs. Example:

 MsgPrintStream myPrintStream = new MsgPrintStream(myMsgDispatcher, 10000, 5000, 100);
 

In this example the range from 1 to 9999 is used for messages which have a defined number outside of this class. Any not numbered message is assigned in the range from 10000 till 149999 if it hasn't a group division, and in groups with the start numbers 15000, 15100 etc. (till 32699 there are 176 groups). Note that the range which can be used is the positive integer range from 0 to about 2000000000. It may be better able to read to have not so large numbers, but there are able to use. Note that you would not have so far different message texts.

Parameters:

logOut - The output where all messages are written after identifier number building. The MsgDispatcher instance is proper to use.

identStart - The first automatically created number used for non grouped message. Note that other messages have a known fixed number. Use a separate range in the positiv Integers range.

sizeNoGroup - number of the non grouped message identifiers. After this range the grouped messages starts. Use a high enough number such as 1000 or 10000 or more.

sizeGroup - Size of any group. Use a middle-high enough number such as 100 or 1000. There won't be more as 1000 several message texts in one group - usually.

Method Detail

getPrintStreamLog

public java.io.PrintStream getPrintStreamLog(java.lang.String pre)

Returns the PrintStream which converts and redirects the output String to the given LogMessage output. One can invoke:

 System.setOut(myMsgPrintStream.getPrintStreamLog("out."));
 System.setErr(myMsgPrintStream.getPrintStreamLog("err."));
 

Then any output to System.out.print... and System.err.print... will be redirected to the LogMessage association given in the constructor of this class. One can create so much as necessary adapters. They uses the same association index between String and list. If the texts are given with setMsgIdents(MsgText_ifc) without the prefix they produces the same message ident number. If the text are given with the prefix, the ident numbers are different. If the association between text and ident is not given before the first call of PrintStream.print..., different prefixes causes different message idents. In this kind for example System.out and System.err can be redirected to different message ident numbers though the output texts are the same.

Invoke for example and as pattern:

 System.setOut(systemPrintAdapter.getPrintStreamLog("out."));     //instead writing to console the PrintStream creates a message
 System.setErr(systemPrintAdapter.getPrintStreamLog("err."));     //and sends it to the message dispatcher.
 

Returns:

A PrintStream instances which is not references anywhere else at this time. You should store this reference. The outer class of this reference is this class.

setMsgIdents

public void setMsgIdents(MsgText_ifc src)

Sets all associations between a message identification text to its ident number or to its number range. Invoke this method before any output is taken via this class, it means before any getPrintStreamLog(String) was build.

The src contains some message texts with ident numbers maybe read from a configuration file. If any MsgText_ifc.MsgConfigItem contains a MsgText_ifc.MsgConfigItem.identText it is associated to its number from MsgText_ifc.MsgConfigItem.identNr or its range to MsgText_ifc.MsgConfigItem.identNrLast stored in this class (idxIdent or idxGroupIdent). If any text is outputted via any MsgPrintStream.PrintStreamAdapter.print(String) or MsgPrintStream.PrintStreamAdapter.printf(String, Object...) and this text has the same start text, this message ident number is taken. The ident numbers can be used to configure a message dispatcher independent but proper to this functionality from the same src. In this kind the messages with identification by text are dispatched accurately.

Specified by:

setMsgIdents in interface MsgPrintStream_ifc

Parameters:

src - The source of association betwenn text and number.

setMsgGroupIdent

public boolean setMsgGroupIdent(java.lang.String sIdent,
                                int nrStart,
                                int nrLast)

Creates a group with the given text and the given ident number range. For this group the numbers inside te group are created automatically, but the group is disposed in a defined fix range. It have to be outside of the range given by constructor.
The method is proper to use if one knows some message texts and one is attempt to dispatch it.

Parameters:

sIdent - The text till the exclusive " - " separation.

nrStart - The first number of the group

nrLast - The last number of the group.

Returns:

false if the group ident msg is known already, it is unchanged (may cause an IllegalArgumentException outside). true if this sIdent is used.

getMsgGroupIdent

private MsgPrintStream.GroupIdent getMsgGroupIdent(java.lang.String pre,
                                                   java.lang.String msg)

convertToMsg

protected void convertToMsg(java.lang.String pre,
                            java.lang.CharSequence identString,
                            java.lang.Object... args)