Source for gnu.xml.pipeline.TextConsumer

   1: /* TextConsumer.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.pipeline;
  39: 
  40: import java.io.*;
  41: 
  42: import org.xml.sax.*;
  43: 
  44: import gnu.xml.util.XMLWriter;
  45: 
  46: 
  47: /**
  48:  * Terminates a pipeline, consuming events to print them as well formed
  49:  * XML (or XHTML) text.
  50:  *
  51:  * <p> Input must be well formed, and must include XML names (e.g. the
  52:  * prefixes and prefix declarations must be present), or the output of
  53:  * this class is undefined.
  54:  *
  55:  * @see NSFilter
  56:  * @see WellFormednessFilter
  57:  *
  58:  * @author David Brownell
  59:  */
  60: public class TextConsumer extends XMLWriter implements EventConsumer
  61: {
  62:     /**
  63:      * Constructs an event consumer which echoes its input as text,
  64:      * optionally adhering to some basic XHTML formatting options
  65:      * which increase interoperability with old (v3) browsers.
  66:      *
  67:      * <p> For the best interoperability, when writing as XHTML only
  68:      * ASCII characters are emitted; other characters are turned to
  69:      * entity or character references as needed, and no XML declaration
  70:      * is provided in the document.
  71:      */
  72:     public TextConsumer (Writer w, boolean isXhtml)
  73:     throws IOException
  74:     {
  75:         super (w, isXhtml ? "US-ASCII" : null);
  76:         setXhtml (isXhtml);
  77:     }
  78: 
  79:     /**
  80:      * Constructs a consumer that writes its input as XML text.
  81:      * XHTML rules are not followed.
  82:      */
  83:     public TextConsumer (Writer w)
  84:     throws IOException
  85:     {
  86:         this (w, false);
  87:     }
  88: 
  89:     /**
  90:      * Constructs a consumer that writes its input as XML text,
  91:      * encoded in UTF-8.  XHTML rules are not followed.
  92:      */
  93:     public TextConsumer (OutputStream out)
  94:     throws IOException
  95:     {
  96:         this (new OutputStreamWriter (out, "UTF8"), false);
  97:     }
  98: 
  99:     /** <b>EventConsumer</b> Returns the document handler being used. */
 100:     public ContentHandler getContentHandler ()
 101:         { return this; }
 102: 
 103:     /** <b>EventConsumer</b> Returns the dtd handler being used. */
 104:     public DTDHandler getDTDHandler ()
 105:         { return this; }
 106: 
 107:     /** <b>XMLReader</b>Retrieves a property (lexical and decl handlers) */
 108:     public Object getProperty (String propertyId)
 109:     throws SAXNotRecognizedException
 110:     {
 111:         if (EventFilter.LEXICAL_HANDLER.equals (propertyId))
 112:             return this;
 113:         if (EventFilter.DECL_HANDLER.equals (propertyId))
 114:             return this;
 115:         throw new SAXNotRecognizedException (propertyId);
 116:     }
 117: }