001/** A message handler that records messages.
002
003 Copyright (c) 2012-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.util.test;
029
030import java.io.PrintWriter;
031import java.io.StringWriter;
032
033import ptolemy.util.MessageHandler;
034
035///////////////////////////////////////////////////////////////////
036//// RecorderMessageHandler
037
038/** A message handler that records messages.
039
040 @author  Christopher Brooks
041 @version $Id$
042 @since Ptolemy II 10.0
043 @Pt.ProposedRating Green (cxh)
044 @Pt.AcceptedRating Green (cxh)
045
046 */
047public class RecorderMessageHandler extends MessageHandler {
048
049    /** Get the messages recorded so far.
050     *  @return The messages.
051     */
052    public String getMessages() {
053        return _buffer.toString();
054    }
055
056    /** Clear the buffer.
057     */
058    public void reset() {
059        _buffer = new StringBuffer();
060    }
061
062    ///////////////////////////////////////////////////////////////////
063    ////                         protected methods                 ////
064
065    /** Show the specified message and throwable information and record.
066     *
067     *  @param info The message.
068     *  @param throwable The throwable.
069     *  @see ptolemy.util.CancelException
070     */
071    @Override
072    protected void _error(String info, Throwable throwable) {
073        //super._error(info, throwable);
074        System.err.println("RecorderMessageHandler: " + info + " " + throwable);
075        StringWriter stringWriter = new StringWriter();
076        PrintWriter printWriter = new PrintWriter(stringWriter);
077        if (throwable != null) {
078            throwable.printStackTrace(printWriter);
079        }
080
081        _buffer.append("RecorderMessageHandler: Error encountered in:\n" + info
082                + "\n" + stringWriter);
083    }
084
085    ///////////////////////////////////////////////////////////////////
086    ////                         private variables                 ////
087    private StringBuffer _buffer = new StringBuffer();
088}