Source for javax.xml.stream.XMLEventWriter

   1: /* XMLEventWriter.java -- 
   2:    Copyright (C) 2005,2006  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 javax.xml.stream;
  39: 
  40: import javax.xml.namespace.NamespaceContext;
  41: import javax.xml.stream.events.XMLEvent;
  42: import javax.xml.stream.util.XMLEventConsumer;
  43: 
  44: /**
  45:  * Interface for writing XML documents from a series of events.
  46:  */
  47: public interface XMLEventWriter
  48:   extends XMLEventConsumer
  49: {
  50: 
  51:   /**
  52:    * Ensures that any cached events are written to the underlying output
  53:    * sink.
  54:    */
  55:   void flush()
  56:     throws XMLStreamException;
  57: 
  58:   /**
  59:    * Frees any resources used by this writer.
  60:    */
  61:   void close()
  62:     throws XMLStreamException;
  63: 
  64:   /**
  65:    * Adds the specified event to this writer.
  66:    */
  67:   void add(XMLEvent event)
  68:     throws XMLStreamException;
  69: 
  70:   /**
  71:    * Adds the specified XML stream to this writer.
  72:    * The implementation will call <code>next</code> on the given argument
  73:    * while <code>hasNext</code> returns true.
  74:    */
  75:   void add(XMLEventReader reader)
  76:     throws XMLStreamException;
  77: 
  78:   /**
  79:    * Returns the namespace prefix the specified URI is currently associated
  80:    * with.
  81:    */
  82:   String getPrefix(String uri)
  83:     throws XMLStreamException;
  84: 
  85:   /**
  86:    * Associates the given namespace prefix and URI.
  87:    */
  88:   void setPrefix(String prefix, String uri)
  89:     throws XMLStreamException;
  90: 
  91:   /**
  92:    * Sets the current default namespace URI.
  93:    */
  94:   void setDefaultNamespace(String uri)
  95:     throws XMLStreamException;
  96: 
  97:   /**
  98:    * Sets the namespace context for managing namespace prefixes and URIs.
  99:    */
 100:   void setNamespaceContext(NamespaceContext context)
 101:     throws XMLStreamException;
 102: 
 103:   /**
 104:    * Returns the namespace context.
 105:    */
 106:   NamespaceContext getNamespaceContext();
 107:   
 108: }