libjava/classpath/gnu/xml/util/XHTMLWriter.java

   1 /* XHTMLWriter.java --
   2    Copyright (C) 1999,2000,2001 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package gnu.xml.util;
  39
  40 import java.io.IOException;
  41 import java.io.OutputStream;
  42 import java.io.OutputStreamWriter;
  43 import java.io.Writer;
  44
  45
  46 /**
  47  * This extends XMLWriter to create a class which defaults to writing
  48  * XHTML text, preferring the US-ASCII encoding.  It adds no unique
  49  * functionality, only changing the defaults slightly to simplify writing
  50  * XHTML processing components by providing a bean class whose properties
  51  * have more convenient defaults.  An artifact of using the US-ASCII
  52  * encoding is that no XML declaration is written, so that HTML tools
  53  * that can't accept them will not become confused.  Components can treat
  54  * the output as UTF-8, ISO-8859-1, or US-ASCII without incurring any
  55  * data loss.
  56  *
  57  * @author David Brownell
  58  *
  59  * @deprecated Please use the javax.xml.stream APIs instead
  60  */
  61 public class XHTMLWriter extends XMLWriter
  62 {
  63     /**
  64      * Constructs this handler with System.out used to write
  65      * SAX events using the US-ASCII encoding, as XHTML.
  66      */
  67     public XHTMLWriter ()
  68     throws IOException
  69     {
  70         this (System.out);
  71     }
  72
  73     /**
  74      * Constructs this handler such that the specified output stream
  75      * is used to write SAX events in the US-ASCII encoding, as XHTML.
  76      *
  77      * @param out Where US-ASCII encoding of the stream of SAX
  78      *  events will be sent.
  79      */
  80     public XHTMLWriter (OutputStream out)
  81     throws IOException
  82     {
  83         // not all JVMs understand "ASCII" as an encoding name, so
  84         // we use 8859_1 (they all seem to handle that one) and
  85         // make the echo handler filter out non-ASCII characters
  86         this (new OutputStreamWriter (out, "8859_1"), "US-ASCII");
  87     }
  88
  89     /**
  90      * Constructs this handler such that the specified output stream
  91      * is used to write SAX events as XHTML.
  92      *
  93      * @param out Where the stream of SAX events will be written.
  94      */
  95     public XHTMLWriter (Writer out)
  96     {
  97         this (out, null);
  98     }
  99
 100     /**
 101      * Constructs this handler such that the specified output stream
 102      * is used to write SAX events as XHTML, labeled with the specified
 103      * encoding.
 104      *
 105      * @param out Where the stream of SAX events will be written.
 106      * @param encoding If non-null, this names the encoding to be
 107      *  placed in the encoding declaration.
 108      */
 109     public XHTMLWriter (Writer out, String encoding)
 110     {
 111         super (out, encoding);
 112         setXhtml (true);
 113     }
 114 }