001/* XMLEventWriter.java --
002   Copyright (C) 2005,2006  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.xml.stream;
039
040import javax.xml.namespace.NamespaceContext;
041import javax.xml.stream.events.XMLEvent;
042import javax.xml.stream.util.XMLEventConsumer;
043
044/**
045 * Interface for writing XML documents from a series of events.
046 */
047public 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}