001/* A debug listener that sends messages to a stream or to standard out.
002
003 Copyright (c) 1998-2014 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026
027 */
028package ptolemy.kernel.util;
029
030import java.io.OutputStream;
031import java.io.PrintStream;
032
033///////////////////////////////////////////////////////////////////
034//// StreamListener
035
036/**
037 A debug listener that sends messages to a stream or to the standard output.
038
039 @author  Edward A. Lee, Christopher Hylands
040 @version $Id$
041 @since Ptolemy II 0.3
042 @Pt.ProposedRating Green (eal)
043 @Pt.AcceptedRating Green (cxh)
044 @see NamedObj
045 @see RecorderListener
046
047 */
048public class StreamListener implements DebugListener {
049    ///////////////////////////////////////////////////////////////////
050    ////                         constructors                      ////
051
052    /** Create a debug listener that sends messages to the standard output.
053     */
054    public StreamListener() {
055        _output = System.out;
056    }
057
058    /** Create a debug listener that sends messages to the specified stream.
059     *  @param out The output stream used to create the debug listener.
060     */
061    public StreamListener(OutputStream out) {
062        _output = new PrintStream(out);
063    }
064
065    ///////////////////////////////////////////////////////////////////
066    ////                         public methods                    ////
067
068    /** Print a string representation of the event to the stream
069     *  associated with this listener.
070     */
071    @Override
072    public void event(DebugEvent event) {
073        _output.println(event.toString());
074    }
075
076    /** Copy the message argument to the stream associated with
077     *  the listener.  Note that a newline is appended to the
078     *  end of the message.
079     */
080    @Override
081    public void message(String message) {
082        _output.println(message);
083    }
084
085    ///////////////////////////////////////////////////////////////////
086    ////                         private variables                 ////
087    private PrintStream _output;
088}