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.*;
052
053/**
054 * This class implements the MsgLogger interface for streams. Streams can
055 * be simple files, terminals, stdout, stderr, etc. The messages or simple
056 * strings are formatted using the linewidth given to the constructor.
057 *
058 * <P>Messages are printed to the 'err' stream if they are of severity WARNING
059 * or ERROR, otherwise they are printed to the 'out' stream. Simple strings
060 * are always printed the 'out' stream.
061 * */
062public class StreamMsgLogger implements MsgLogger {
063
064    /** The 'out' stream */
065    private PrintWriter out;
066
067    /** The 'err' stream */
068    private PrintWriter err;
069
070    /** The printer that formats the text */
071    private MsgPrinter mp;
072
073    /**
074     * Constructs a StreamMsgLogger that uses 'outstr' as the 'out' stream,
075     * and 'errstr' as the 'err' stream. Note that 'outstr' and 'errstr' can
076     * be System.out and System.err.
077     *
078     * @param outstr Where to print simple strings and LOG and INFO messages.
079     *
080     * @param errstr Where to print WARNING and ERROR messages
081     *
082     * @param lw The line width to use in formatting
083     *
084     *
085     * */
086    public StreamMsgLogger(OutputStream outstr, OutputStream errstr, int lw) {
087        out = new PrintWriter(outstr,true);
088        err = new PrintWriter(errstr,true);
089        mp = new MsgPrinter(lw);
090    }
091
092    /**
093     * Constructs a StreamMsgLogger that uses 'outstr' as the 'out' stream,
094     * and 'errstr' as the 'err' stream. Note that 'outstr' and 'errstr' can
095     * be System.out and System.err.
096     *
097     * @param outstr Where to print simple strings and LOG and INFO messages.
098     *
099     * @param errstr Where to print WARNING and ERROR messages
100     *
101     * @param lw The line width to use in formatting
102     *
103     *
104     * */
105    public StreamMsgLogger(Writer outstr, Writer errstr, int lw) {
106        out = new PrintWriter(outstr,true);
107        err = new PrintWriter(errstr,true);
108        mp = new MsgPrinter(lw);
109    }
110
111    /**
112     * Constructs a StreamMsgLogger that uses 'outstr' as the 'out' stream,
113     * and 'errstr' as the 'err' stream. Note that 'outstr' and 'errstr' can
114     * be System.out and System.err.
115     *
116     * @param outstr Where to print simple strings and LOG and INFO messages.
117     *
118     * @param errstr Where to print WARNING and ERROR messages
119     *
120     * @param lw The line width to use in formatting
121     *
122     *
123     * */
124    public StreamMsgLogger(PrintWriter outstr, PrintWriter errstr, int lw) {
125        out = outstr;
126        err = errstr;
127        mp = new MsgPrinter(lw);
128    }
129
130    /**
131     * Prints the message 'msg' to the output device, appending a newline,
132     * with severity 'sev'. The severity of the message is prepended to the
133     * message.
134     *
135     * @param sev The message severity (LOG, INFO, etc.)
136     *
137     * @param msg The message to display
138     *
139     *
140     * */
141    public void printmsg(int sev, String msg) {
142        PrintWriter lout;
143        int ind;
144        String prefix;
145
146        switch (sev) {
147        case LOG:
148            prefix = "[LOG]: ";
149            lout = out;
150            break;
151        case INFO:
152            prefix = "[INFO]: ";
153            lout = out;
154            break;
155        case WARNING:
156            prefix = "[WARNING]: ";
157            lout = err;
158            break;
159        case ERROR:
160            prefix = "[ERROR]: ";
161            lout = err;
162            break;
163        default:
164            throw new IllegalArgumentException("Severity "+sev+" not valid.");
165        }
166
167        mp.print(lout,0,prefix.length(),prefix+msg);
168        lout.flush();
169    }
170
171    /**
172     * Prints the string 'str' to the 'out' stream, appending a newline. The
173     * message is reformatted to the line width given to the constructors and
174     * using 'flind' characters to indent the first line and 'ind' characters
175     * to indent the second line. However, any newlines appearing in 'str' are
176     * respected. The output device may or may not display the string until
177     * flush() is called, depending on the autoflush state of the PrintWriter,
178     * to be sure flush() should be called to write the string to the
179     * device. This method just prints the string, the string does not make
180     * part of a "message" in the sense that noe severity is associated to it.
181     *
182     * @param str The string to print
183     *
184     * @param flind Indentation of the first line
185     *
186     * @param ind Indentation of any other lines.
187     *
188     *
189     * */
190    public void println(String str, int flind, int ind) {
191        mp.print(out,flind,ind,str);
192    }
193
194    /**
195     * Writes any buffered data from the print() and println() methods to the
196     * device.
197     *
198     *
199     * */
200    public void flush() {
201        out.flush();
202    }
203
204}