/*
 * $Id: XhtmlEchoHandler.java,v 1.1.1.1 2002/09/30 15:08:51 smartine Exp $
 * Copyright (C) 1999-2000 David Brownell
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package xml;

import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;


// $Id: XhtmlEchoHandler.java,v 1.1.1.1 2002/09/30 15:08:51 smartine Exp $

/**
 * This extends the EchoHandler to create a class which defaults to writing
 * XHTML text, preferring the US-ASCII encoding.  It adds no unique
 * functionality, only changing the defaults slightly to simplify writing
 * XHTML processing components by providing a bean class whose properties
 * have more convenient defaults.  An artifact of using the US-ASCII
 * encoding is that no XML declaration is written, so that HTML tools
 * that can't accept them will not become confused.  Components can treat
 * the output as UTF-8, ISO-8859-1, or US-ASCII without incurring any
 * data loss.
 *
 * @author David Brownell
 * @version $Date: 2002/09/30 15:08:51 $
 */
public class XhtmlEchoHandler extends EchoHandler
{
    /**
     * Constructs this handler with System.out used to write
     * SAX events using the US-ASCII encoding, as XHTML.
     */
    public XhtmlEchoHandler ()
    throws IOException
    {
	this (System.out);
    }

    /**
     * Constructs this handler such that the specified output stream
     * is used to write SAX events in the US-ASCII encoding, as XHTML.
     *
     * @param out Where US-ASCII encoding of the stream of SAX
     *	events will be sent.
     */
    public XhtmlEchoHandler (OutputStream out)
    throws IOException
    {
	// not all JVMs understand "ASCII" as an encoding name, so
	// we use 8859_1 (they all seem to handle that one) and
	// make the echo handler filter out non-ASCII characters
	this (new OutputStreamWriter (out, "8859_1"), "US-ASCII");
    }

    /**
     * Constructs this handler such that the specified output stream
     * is used to write SAX events as XHTML.
     *
     * @param out Where the stream of SAX events will be written.
     */
    public XhtmlEchoHandler (Writer out)
    {
	this (out, null);
    }

    /**
     * Constructs this handler such that the specified output stream
     * is used to write SAX events as XHTML, labeled with the specified
     * encoding.
     *
     * @param out Where the stream of SAX events will be written.
     * @param encoding If non-null, this names the encoding to be
     *	placed in the encoding declaration.
     */
    public XhtmlEchoHandler (Writer out, String encoding)
    {
	super (out, encoding);
	setXhtml (true);
    }
}