001    /* XMLEventWriter.java --
002       Copyright (C) 2005,2006  Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    package javax.xml.stream;
039    
040    import javax.xml.namespace.NamespaceContext;
041    import javax.xml.stream.events.XMLEvent;
042    import javax.xml.stream.util.XMLEventConsumer;
043    
044    /**
045     * Interface for writing XML documents from a series of events.
046     */
047    public interface XMLEventWriter
048      extends XMLEventConsumer
049    {
050    
051      /**
052       * Ensures that any cached events are written to the underlying output
053       * sink.
054       */
055      void flush()
056        throws XMLStreamException;
057    
058      /**
059       * Frees any resources used by this writer.
060       */
061      void close()
062        throws XMLStreamException;
063    
064      /**
065       * Adds the specified event to this writer.
066       */
067      void add(XMLEvent event)
068        throws XMLStreamException;
069    
070      /**
071       * Adds the specified XML stream to this writer.
072       * The implementation will call <code>next</code> on the given argument
073       * while <code>hasNext</code> returns true.
074       */
075      void add(XMLEventReader reader)
076        throws XMLStreamException;
077    
078      /**
079       * Returns the namespace prefix the specified URI is currently associated
080       * with.
081       */
082      String getPrefix(String uri)
083        throws XMLStreamException;
084    
085      /**
086       * Associates the given namespace prefix and URI.
087       */
088      void setPrefix(String prefix, String uri)
089        throws XMLStreamException;
090    
091      /**
092       * Sets the current default namespace URI.
093       */
094      void setDefaultNamespace(String uri)
095        throws XMLStreamException;
096    
097      /**
098       * Sets the namespace context for managing namespace prefixes and URIs.
099       */
100      void setNamespaceContext(NamespaceContext context)
101        throws XMLStreamException;
102    
103      /**
104       * Returns the namespace context.
105       */
106      NamespaceContext getNamespaceContext();
107    
108    }