You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by cu...@apache.org on 2001/02/21 20:37:18 UTC
cvs commit: xml-xalan/test/java/src/org/apache/qetest LoggingHandler.java
curcuru 01/02/21 11:37:17
Added: test/java/src/org/apache/qetest LoggingHandler.java
Log:
New base class for test logging wrappers for various
error handlers/listeners
Revision Changes Path
1.1 xml-xalan/test/java/src/org/apache/qetest/LoggingHandler.java
Index: LoggingHandler.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 2000-2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xalan" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 2000, Lotus
* Development Corporation., http://www.lotus.com. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
/*
*
* LoggingHandler.java
*
*/
package org.apache.qetest;
/**
* Base class defining common functionality of logging handlers.
* <p>Common functionality used for testing when implementing
* various Handlers and Listeners. Provides common ways to set
* Loggers and levels, reset, and set expected errors or the
* like. Likely used to implement testing wrapper classes for
* things like javax.xml.transform.ErrorListener and
* org.xml.sax.ErrorHandler</p>
* <p>The best description for this class can be seen in an
* example; see trax.LoggingErrorHandler.java for one.</p>
* @author shane_curcuru@lotus.com
* @version $Id: LoggingHandler.java,v 1.1 2001/02/21 19:37:17 curcuru Exp $
*/
public class LoggingHandler
{
/**
* Get a list of counters of all items we've logged.
* LoggingHandlers each will have various kinds or types of
* things they handle (errors, warnings, messages, URIs, etc.).
* They should keep a running tally of how many of each kind of
* item they've 'handled'.
*
* @return array of int counters for each item we log;
* subclasses should define constants for what each slot is
*/
public int[] getCounters()
{
return NOTHING_HANDLED_CTR;
}
/**
* Get a string representation of last item we logged.
* For every item that we handle, subclasses should store a
* String representation and return it here if asked. Normally
* this will only be a copy of the very last item we logged -
* not necessarily what users might want, but the simplest to
* implement everywhere.
*
* @return String of the last item handled
*/
public String getLast()
{
return NOTHING_HANDLED;
}
/**
* Reset any items or counters we've handled.
* Resets any data about what we've handled or logged so far,
* like getLast() and getCounters() data, as well as any
* expected items from setExpected(). Does not change our
* Logger or loggingLevel.
*/
public void reset()
{
/* no-op */;
}
/**
* Ask us to report checkPass/Fail for certain events we handle.
* Since we may have to handle many events between when a test
* will be able to call us, testers can set this to have us
* automatically call checkPass when we see an item that matches,
* or to call checkFail when we get an unexpected item.
* Generally, we only call check* methods when:
* <ul>
* <li>containsString is not set, reset, or is ITEM_DONT_CARE,
* we do nothing (i.e. never call check* for this item)</li>
* <li>containsString is ITEM_CHECKFAIL, we will always call
* checkFail with the contents of any item if it occours</li>
* <li>containsString is anything else, we will grab a String
* representation of every item of that type that comes along,
* and if the containsString is found, case-sensitive, within
* the handled item's string, call checkPass, otherwise
* call checkFail</li>
* <ul>
* Note that most implementations will only validate the first
* event of a specific type, and then will reset validation for
* that event type. This is because many events may be raised
* in between the time that a calling Test class could tell us
* of the 'next' expected event.
* //@todo improve this paradigm to allow users to specify an
* expected sequence of events.
*
* @param itemType which of the various types of items we might
* handle; should be defined as a constant by subclasses
* @param containsString a string to look for within whatever
* item we handle - usually checked for by seeing if the actual
* item we handle contains the containsString
*/
public void setExpected(int itemType, String containsString)
{
/* no-op */;
}
/**
* Accesor method for a brief description of this service.
* Subclasses should obviously override to provide useful info.
*
* @return String "LoggingHandler: default implementation, does nothing"
*/
public String getDescription()
{
return "LoggingHandler: default implementation, does nothing";
}
/**
* Accesor methods for our Logger.
*
* @param l the Logger to have this test use for logging
* results; or null to use a default logger
*/
public void setLogger(Logger l)
{
// if null, set a default one
if (null == l)
logger = getDefaultLogger();
else
logger = l;
}
/**
* Accesor methods for our Logger.
*
* @return Logger we tell all our secrets to.
*/
public Logger getLogger()
{
return logger;
}
/**
* Get a default Logger for use with this Handler.
* Gets a default ConsoleLogger (only if a Logger isn't
* currently set!).
*
* @return current logger; if null, then creates a
* Logger.DEFAULT_LOGGER and returns that; if it cannot
* create one, throws a RuntimeException
*/
public Logger getDefaultLogger()
{
if (logger != null)
return logger;
try
{
Class rClass = Class.forName(Logger.DEFAULT_LOGGER);
return (Logger)rClass.newInstance();
}
catch (Exception e)
{
// Must re-throw the exception, since returning
// null or the like could lead to recursion
e.printStackTrace();
throw new RuntimeException(e.toString());
}
}
/**
* Accesor methods for our loggingLevel.
*
* @param l what level we should call logger.logMsg()
*/
public void setLoggingLevel(int l)
{
level = l;
}
/**
* Accesor methods for our loggingLevel.
*
* @return what level we call logger.logMsg()
*/
public int getLoggingLevel()
{
return level;
}
//-----------------------------------------------------------
//---- Instance Variables and Constants
//-----------------------------------------------------------
/** Our Logger, who we tell all our secrets to. */
protected Logger logger = null;
/** What loggingLevel to use for reporter.logMsg(). */
protected int level = Logger.DEFAULT_LOGGINGLEVEL;
/** Default return value from getCounters() after a reset(). */
public static final int[] NOTHING_HANDLED_CTR = { 0 };
/** Default return value from getLast() after a reset(). */
public static final String NOTHING_HANDLED = "NOTHING_HANDLED";
/** Token for setExpected that we don't care (default value) about the event. */
public static final String ITEM_DONT_CARE = "ITEM_DONT_CARE";
/** Token for setExpected that we should call checkFail if we get the event. */
public static final String ITEM_CHECKFAIL = "ITEM_CHECKFAIL";
}