001/*
002 * $RCSfile: StreamMsgLogger.java,v $
003 * $Revision: 1.1 $
004 * $Date: 2005/02/11 05:02:26 $
005 * $State: Exp $
006 *
007 * Class:                   StreamMsgLogger
008 *
009 * Description:             Implementation of MsgLogger for streams
010 *
011 *
012 *
013 * COPYRIGHT:
014 *
015 * This software module was originally developed by Raphaël Grosbois and
016 * Diego Santa Cruz (Swiss Federal Institute of Technology-EPFL); Joel
017 * Askelöf (Ericsson Radio Systems AB); and Bertrand Berthelot, David
018 * Bouchard, Félix Henry, Gerard Mozelle and Patrice Onno (Canon Research
019 * Centre France S.A) in the course of development of the JPEG2000
020 * standard as specified by ISO/IEC 15444 (JPEG 2000 Standard). This
021 * software module is an implementation of a part of the JPEG 2000
022 * Standard. Swiss Federal Institute of Technology-EPFL, Ericsson Radio
023 * Systems AB and Canon Research Centre France S.A (collectively JJ2000
024 * Partners) agree not to assert against ISO/IEC and users of the JPEG
025 * 2000 Standard (Users) any of their rights under the copyright, not
026 * including other intellectual property rights, for this software module
027 * with respect to the usage by ISO/IEC and Users of this software module
028 * or modifications thereof for use in hardware or software products
029 * claiming conformance to the JPEG 2000 Standard. Those intending to use
030 * this software module in hardware or software products are advised that
031 * their use may infringe existing patents. The original developers of
032 * this software module, JJ2000 Partners and ISO/IEC assume no liability
033 * for use of this software module or modifications thereof. No license
034 * or right to this software module is granted for non JPEG 2000 Standard
035 * conforming products. JJ2000 Partners have full right to use this
036 * software module for his/her own purpose, assign or donate this
037 * software module to any third party and to inhibit third parties from
038 * using this software module for non JPEG 2000 Standard conforming
039 * products. This copyright notice must be included in all copies or
040 * derivative works of this software module.
041 *
042 * Copyright (c) 1999/2000 JJ2000 Partners.
043 *
044 *
045 *
046 */
047
048
049package jj2000.j2k.util;
050
051import java.io.OutputStream;
052import java.io.PrintWriter;
053import java.io.Writer;
054
055/**
056 * This class implements the MsgLogger interface for streams. Streams can
057 * be simple files, terminals, stdout, stderr, etc. The messages or simple
058 * strings are formatted using the linewidth given to the constructor.
059 *
060 * <P>Messages are printed to the 'err' stream if they are of severity WARNING
061 * or ERROR, otherwise they are printed to the 'out' stream. Simple strings
062 * are always printed the 'out' stream.
063 * */
064public class StreamMsgLogger implements MsgLogger {
065
066    /** The 'out' stream */
067    private PrintWriter out;
068
069    /** The 'err' stream */
070    private PrintWriter err;
071
072    /** The printer that formats the text */
073    private MsgPrinter mp;
074
075    /**
076     * Constructs a StreamMsgLogger that uses 'outstr' as the 'out' stream,
077     * and 'errstr' as the 'err' stream. Note that 'outstr' and 'errstr' can
078     * be System.out and System.err.
079     *
080     * @param outstr Where to print simple strings and LOG and INFO messages.
081     *
082     * @param errstr Where to print WARNING and ERROR messages
083     *
084     * @param lw The line width to use in formatting
085     *
086     *
087     * */
088    public StreamMsgLogger(OutputStream outstr, OutputStream errstr, int lw) {
089        out = new PrintWriter(outstr,true);
090        err = new PrintWriter(errstr,true);
091        mp = new MsgPrinter(lw);
092    }
093
094    /**
095     * Constructs a StreamMsgLogger that uses 'outstr' as the 'out' stream,
096     * and 'errstr' as the 'err' stream. Note that 'outstr' and 'errstr' can
097     * be System.out and System.err.
098     *
099     * @param outstr Where to print simple strings and LOG and INFO messages.
100     *
101     * @param errstr Where to print WARNING and ERROR messages
102     *
103     * @param lw The line width to use in formatting
104     *
105     *
106     * */
107    public StreamMsgLogger(Writer outstr, Writer errstr, int lw) {
108        out = new PrintWriter(outstr,true);
109        err = new PrintWriter(errstr,true);
110        mp = new MsgPrinter(lw);
111    }
112
113    /**
114     * Constructs a StreamMsgLogger that uses 'outstr' as the 'out' stream,
115     * and 'errstr' as the 'err' stream. Note that 'outstr' and 'errstr' can
116     * be System.out and System.err.
117     *
118     * @param outstr Where to print simple strings and LOG and INFO messages.
119     *
120     * @param errstr Where to print WARNING and ERROR messages
121     *
122     * @param lw The line width to use in formatting
123     *
124     *
125     * */
126    public StreamMsgLogger(PrintWriter outstr, PrintWriter errstr, int lw) {
127        out = outstr;
128        err = errstr;
129        mp = new MsgPrinter(lw);
130    }
131
132    /**
133     * Prints the message 'msg' to the output device, appending a newline,
134     * with severity 'sev'. The severity of the message is prepended to the
135     * message.
136     *
137     * @param sev The message severity (LOG, INFO, etc.)
138     *
139     * @param msg The message to display
140     *
141     *
142     * */
143    public void printmsg(int sev, String msg) {
144        PrintWriter lout;
145        int ind;
146        String prefix;
147
148        switch (sev) {
149        case LOG:
150            prefix = "[LOG]: ";
151            lout = out;
152            break;
153        case INFO:
154            prefix = "[INFO]: ";
155            lout = out;
156            break;
157        case WARNING:
158            prefix = "[WARNING]: ";
159            lout = err;
160            break;
161        case ERROR:
162            prefix = "[ERROR]: ";
163            lout = err;
164            break;
165        default:
166            throw new IllegalArgumentException("Severity "+sev+" not valid.");
167        }
168
169        mp.print(lout,0,prefix.length(),prefix+msg);
170        lout.flush();
171    }
172
173    /**
174     * Prints the string 'str' to the 'out' stream, appending a newline. The
175     * message is reformatted to the line width given to the constructors and
176     * using 'flind' characters to indent the first line and 'ind' characters
177     * to indent the second line. However, any newlines appearing in 'str' are
178     * respected. The output device may or may not display the string until
179     * flush() is called, depending on the autoflush state of the PrintWriter,
180     * to be sure flush() should be called to write the string to the
181     * device. This method just prints the string, the string does not make
182     * part of a "message" in the sense that noe severity is associated to it.
183     *
184     * @param str The string to print
185     *
186     * @param flind Indentation of the first line
187     *
188     * @param ind Indentation of any other lines.
189     *
190     *
191     * */
192    public void println(String str, int flind, int ind) {
193        mp.print(out,flind,ind,str);
194    }
195
196    /**
197     * Writes any buffered data from the print() and println() methods to the
198     * device.
199     *
200     *
201     * */
202    public void flush() {
203        out.flush();
204    }
205
206}