Class XMLEventWriterBase

java.lang.Object
com.bea.xml.stream.XMLEventWriterBase
All Implemented Interfaces:
XMLEventConsumer, XMLEventWriter

public class XMLEventWriterBase extends Object implements XMLEventWriter, XMLEventConsumer

The base writer class

  • Constructor Details

  • Method Details

    • flush

      public void flush() throws XMLStreamException
      Description copied from interface: javax.xml.stream.XMLEventWriter
      Writes any cached events to the underlying output mechanism
      Specified by:
      flush in interface XMLEventWriter
      Throws:
      XMLStreamException
    • close

      public void close() throws XMLStreamException
      Description copied from interface: javax.xml.stream.XMLEventWriter
      Frees any resources associated with this stream
      Specified by:
      close in interface XMLEventWriter
      Throws:
      XMLStreamException
    • addCharacters

      public void addCharacters(Characters cd) throws XMLStreamException
      Throws:
      XMLStreamException
    • addEntityReference

      public void addEntityReference(EntityReference er) throws XMLStreamException
      Throws:
      XMLStreamException
    • addProcessingInstruction

      public void addProcessingInstruction(ProcessingInstruction pi) throws XMLStreamException
      Throws:
      XMLStreamException
    • addComment

      public void addComment(Comment c) throws XMLStreamException
      Throws:
      XMLStreamException
    • addStartDocument

      public void addStartDocument(StartDocument sd) throws XMLStreamException
      Throws:
      XMLStreamException
    • addEndDocument

      public void addEndDocument(EndDocument ed) throws XMLStreamException
      Throws:
      XMLStreamException
    • addAttribute

      public void addAttribute(Attribute a) throws XMLStreamException
      Throws:
      XMLStreamException
    • writeNamespace

      public void writeNamespace(Namespace n) throws XMLStreamException
      Throws:
      XMLStreamException
    • addNamespace

      public void addNamespace(Namespace ns) throws XMLStreamException
      Throws:
      XMLStreamException
    • addDTD

      public void addDTD(DTD dtd) throws XMLStreamException
      Throws:
      XMLStreamException
    • add

      public void add(XMLEvent e) throws XMLStreamException
      Description copied from interface: javax.xml.stream.XMLEventWriter
      Add an event to the output stream Adding a START_ELEMENT will open a new namespace scope that will be closed when the corresponding END_ELEMENT is written.
      Required and optional fields for events added to the writer
      Event Type Required Fields Optional Fields Required Behavior
      START_ELEMENT QName name namespaces , attributes A START_ELEMENT will be written by writing the name, namespaces, and attributes of the event in XML 1.0 valid syntax for START_ELEMENTs. The name is written by looking up the prefix for the namespace uri. The writer can be configured to respect prefixes of QNames. If the writer is respecting prefixes it must use the prefix set on the QName. The default behavior is to lookup the value for the prefix on the EventWriter's internal namespace context. Each attribute (if any) is written using the behavior specified in the attribute section of this table. Each namespace (if any) is written using the behavior specified in the namespace section of this table.
      END_ELEMENT Qname name None A well formed END_ELEMENT tag is written. The name is written by looking up the prefix for the namespace uri. The writer can be configured to respect prefixes of QNames. If the writer is respecting prefixes it must use the prefix set on the QName. The default behavior is to lookup the value for the prefix on the EventWriter's internal namespace context. If the END_ELEMENT name does not match the START_ELEMENT name an XMLStreamException is thrown.
      ATTRIBUTE QName name , String value QName type An attribute is written using the same algorithm to find the lexical form as used in START_ELEMENT. The default is to use double quotes to wrap attribute values and to escape any double quotes found in the value. The type value is ignored.
      NAMESPACE String prefix, String namespaceURI, boolean isDefaultNamespaceDeclaration None A namespace declaration is written. If the namespace is a default namespace declaration (isDefault is true) then xmlns="$namespaceURI" is written and the prefix is optional. If isDefault is false, the prefix must be declared and the writer must prepend xmlns to the prefix and write out a standard prefix declaration.
      PROCESSING_INSTRUCTION None String target, String data The data does not need to be present and may be null. Target is required and many not be null. The writer will write data section directly after the target, enclosed in appropriate XML 1.0 syntax
      COMMENT None String comment If the comment is present (not null) it is written, otherwise an an empty comment is written
      START_DOCUMENT None String encoding , boolean standalone, String version A START_DOCUMENT event is not required to be written to the stream. If present the attributes are written inside the appropriate XML declaration syntax
      END_DOCUMENT None None Nothing is written to the output
      DTD String DocumentTypeDefinition None The DocumentTypeDefinition is written to the output
      Specified by:
      add in interface XMLEventConsumer
      Specified by:
      add in interface XMLEventWriter
      Parameters:
      e - the event to be added
      Throws:
      XMLStreamException
    • add

      public void add(XMLEventReader stream) throws XMLStreamException
      Description copied from interface: javax.xml.stream.XMLEventWriter
      Adds an entire stream to an output stream, calls next() on the inputStream argument until hasNext() returns false This should be treated as a convenience method that will perform the following loop over all the events in an event reader and call add on each event.
      Specified by:
      add in interface XMLEventWriter
      Parameters:
      stream - the event stream to add to the output
      Throws:
      XMLStreamException
    • getPrefix

      public String getPrefix(String uri) throws XMLStreamException
      Description copied from interface: javax.xml.stream.XMLEventWriter
      Gets the prefix the uri is bound to
      Specified by:
      getPrefix in interface XMLEventWriter
      Parameters:
      uri - the uri to look up
      Throws:
      XMLStreamException
    • setPrefix

      public void setPrefix(String prefix, String uri) throws XMLStreamException
      Description copied from interface: javax.xml.stream.XMLEventWriter
      Sets the prefix the uri is bound to. This prefix is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the prefix is bound in the root scope.
      Specified by:
      setPrefix in interface XMLEventWriter
      Parameters:
      prefix - the prefix to bind to the uri
      uri - the uri to bind to the prefix
      Throws:
      XMLStreamException
    • setDefaultNamespace

      public void setDefaultNamespace(String uri) throws XMLStreamException
      Description copied from interface: javax.xml.stream.XMLEventWriter
      Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the uri is bound in the root scope.
      Specified by:
      setDefaultNamespace in interface XMLEventWriter
      Parameters:
      uri - the uri to bind to the default namespace
      Throws:
      XMLStreamException
    • setNamespaceContext

      public void setNamespaceContext(NamespaceContext context) throws XMLStreamException
      Description copied from interface: javax.xml.stream.XMLEventWriter
      Sets the current namespace context for prefix and uri bindings. This context becomes the root namespace context for writing and will replace the current root namespace context. Subsequent calls to setPrefix and setDefaultNamespace will bind namespaces using the context passed to the method as the root context for resolving namespaces.
      Specified by:
      setNamespaceContext in interface XMLEventWriter
      Parameters:
      context - the namespace context to use for this writer
      Throws:
      XMLStreamException
    • getNamespaceContext

      public NamespaceContext getNamespaceContext()
      Description copied from interface: javax.xml.stream.XMLEventWriter
      Returns the current namespace context.
      Specified by:
      getNamespaceContext in interface XMLEventWriter
      Returns:
      the current namespace context
    • main

      public static void main(String[] args) throws Exception
      Throws:
      Exception