Package | Description |
---|---|
javax.xml.stream | |
javax.xml.stream.events | |
javax.xml.stream.util | |
javax.xml.transform.stax |
Provides for StAX-specific transformation APIs.
|
Modifier and Type | Method and Description |
---|---|
void |
XMLEventWriter.add(XMLEvent event)
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.
|
void |
XMLEventWriter.add(XMLEventReader reader)
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.
|
void |
XMLEventWriter.close()
Frees any resources associated with this stream
|
void |
XMLStreamWriter.close()
Close this writer and free any resources associated with the
writer.
|
void |
XMLEventReader.close()
Frees any resources associated with this Reader.
|
void |
XMLStreamReader.close()
Frees any resources associated with this Reader.
|
abstract XMLEventReader |
XMLInputFactory.createFilteredReader(XMLEventReader reader,
EventFilter filter)
Create a filtered event reader that wraps the filter around the event reader
|
abstract XMLStreamReader |
XMLInputFactory.createFilteredReader(XMLStreamReader reader,
StreamFilter filter)
Create a filtered reader that wraps the filter around the reader
|
abstract XMLEventReader |
XMLInputFactory.createXMLEventReader(InputStream stream)
Create a new XMLEventReader from a java.io.InputStream
|
abstract XMLEventReader |
XMLInputFactory.createXMLEventReader(InputStream stream,
String encoding)
Create a new XMLEventReader from a java.io.InputStream
|
abstract XMLEventReader |
XMLInputFactory.createXMLEventReader(Reader reader)
Create a new XMLEventReader from a reader
|
abstract XMLEventReader |
XMLInputFactory.createXMLEventReader(Source source)
Create a new XMLEventReader from a JAXP source.
|
abstract XMLEventReader |
XMLInputFactory.createXMLEventReader(String systemId,
InputStream stream)
Create a new XMLEventReader from a java.io.InputStream
|
abstract XMLEventReader |
XMLInputFactory.createXMLEventReader(String systemId,
Reader reader)
Create a new XMLEventReader from a reader
|
abstract XMLEventReader |
XMLInputFactory.createXMLEventReader(XMLStreamReader reader)
Create a new XMLEventReader from an XMLStreamReader.
|
abstract XMLEventWriter |
XMLOutputFactory.createXMLEventWriter(OutputStream stream)
Create a new XMLEventWriter that writes to a stream
|
abstract XMLEventWriter |
XMLOutputFactory.createXMLEventWriter(OutputStream stream,
String encoding)
Create a new XMLEventWriter that writes to a stream
|
abstract XMLEventWriter |
XMLOutputFactory.createXMLEventWriter(Result result)
Create a new XMLEventWriter that writes to a JAXP result.
|
abstract XMLEventWriter |
XMLOutputFactory.createXMLEventWriter(Writer stream)
Create a new XMLEventWriter that writes to a writer
|
abstract XMLStreamReader |
XMLInputFactory.createXMLStreamReader(InputStream stream)
Create a new XMLStreamReader from a java.io.InputStream
|
abstract XMLStreamReader |
XMLInputFactory.createXMLStreamReader(InputStream stream,
String encoding)
Create a new XMLStreamReader from a java.io.InputStream
|
abstract XMLStreamReader |
XMLInputFactory.createXMLStreamReader(Reader reader)
Create a new XMLStreamReader from a reader
|
abstract XMLStreamReader |
XMLInputFactory.createXMLStreamReader(Source source)
Create a new XMLStreamReader from a JAXP source.
|
abstract XMLStreamReader |
XMLInputFactory.createXMLStreamReader(String systemId,
InputStream stream)
Create a new XMLStreamReader from a java.io.InputStream
|
abstract XMLStreamReader |
XMLInputFactory.createXMLStreamReader(String systemId,
Reader reader)
Create a new XMLStreamReader from a java.io.InputStream
|
abstract XMLStreamWriter |
XMLOutputFactory.createXMLStreamWriter(OutputStream stream)
Create a new XMLStreamWriter that writes to a stream
|
abstract XMLStreamWriter |
XMLOutputFactory.createXMLStreamWriter(OutputStream stream,
String encoding)
Create a new XMLStreamWriter that writes to a stream
|
abstract XMLStreamWriter |
XMLOutputFactory.createXMLStreamWriter(Result result)
Create a new XMLStreamWriter that writes to a JAXP result.
|
abstract XMLStreamWriter |
XMLOutputFactory.createXMLStreamWriter(Writer stream)
Create a new XMLStreamWriter that writes to a writer
|
void |
XMLEventWriter.flush()
Writes any cached events to the underlying output mechanism
|
void |
XMLStreamWriter.flush()
Write any cached data to the underlying output mechanism.
|
String |
XMLEventReader.getElementText()
Reads the content of a text-only element.
|
String |
XMLStreamReader.getElementText()
Reads the content of a text-only element, an exception is thrown if this is
not a text-only element.
|
String |
XMLEventWriter.getPrefix(String uri)
Gets the prefix the uri is bound to
|
String |
XMLStreamWriter.getPrefix(String uri)
Gets the prefix the uri is bound to
|
int |
XMLStreamReader.getTextCharacters(int sourceStart,
char[] target,
int targetStart,
int length)
Gets the the text associated with a CHARACTERS, SPACE or CDATA event.
|
boolean |
XMLStreamReader.hasNext()
Returns true if there are more parsing events and false
if there are no more events.
|
int |
XMLStreamReader.next()
Get next parsing event - a processor may return all contiguous
character data in a single chunk, or it may split it into several chunks.
|
XMLEvent |
XMLEventReader.nextEvent()
Get the next XMLEvent
|
XMLEvent |
XMLEventReader.nextTag()
Skips any insignificant space events until a START_ELEMENT or
END_ELEMENT is reached.
|
int |
XMLStreamReader.nextTag()
Skips any white space (isWhiteSpace() returns true), COMMENT,
or PROCESSING_INSTRUCTION,
until a START_ELEMENT or END_ELEMENT is reached.
|
XMLEvent |
XMLEventReader.peek()
Check the next XMLEvent without reading it from the stream.
|
void |
XMLReporter.report(String message,
String errorType,
Object relatedInformation,
Location location)
Report the desired message in an application specific format.
|
void |
XMLStreamReader.require(int type,
String namespaceURI,
String localName)
Test if the current event is of the given type and if the namespace and name match the current
namespace and name of the current event.
|
Object |
XMLResolver.resolveEntity(String publicID,
String systemID,
String baseURI,
String namespace)
Retrieves a resource.
|
void |
XMLEventWriter.setDefaultNamespace(String uri)
Binds a URI to the default namespace
This URI is bound
in the scope of the current START_ELEMENT / END_ELEMENT pair.
|
void |
XMLStreamWriter.setDefaultNamespace(String uri)
Binds a URI to the default namespace
This URI is bound
in the scope of the current START_ELEMENT / END_ELEMENT pair.
|
void |
XMLEventWriter.setNamespaceContext(NamespaceContext context)
Sets the current namespace context for prefix and uri bindings.
|
void |
XMLStreamWriter.setNamespaceContext(NamespaceContext context)
Sets the current namespace context for prefix and uri bindings.
|
void |
XMLEventWriter.setPrefix(String prefix,
String uri)
Sets the prefix the uri is bound to.
|
void |
XMLStreamWriter.setPrefix(String prefix,
String uri)
Sets the prefix the uri is bound to.
|
void |
XMLStreamWriter.writeAttribute(String localName,
String value)
Writes an attribute to the output stream without
a prefix.
|
void |
XMLStreamWriter.writeAttribute(String namespaceURI,
String localName,
String value)
Writes an attribute to the output stream
|
void |
XMLStreamWriter.writeAttribute(String prefix,
String namespaceURI,
String localName,
String value)
Writes an attribute to the output stream
|
void |
XMLStreamWriter.writeCData(String data)
Writes a CData section
|
void |
XMLStreamWriter.writeCharacters(char[] text,
int start,
int len)
Write text to the output
|
void |
XMLStreamWriter.writeCharacters(String text)
Write text to the output
|
void |
XMLStreamWriter.writeComment(String data)
Writes an xml comment with the data enclosed
|
void |
XMLStreamWriter.writeDefaultNamespace(String namespaceURI)
Writes the default namespace to the stream
|
void |
XMLStreamWriter.writeDTD(String dtd)
Write a DTD section.
|
void |
XMLStreamWriter.writeEmptyElement(String localName)
Writes an empty element tag to the output
|
void |
XMLStreamWriter.writeEmptyElement(String namespaceURI,
String localName)
Writes an empty element tag to the output
|
void |
XMLStreamWriter.writeEmptyElement(String prefix,
String localName,
String namespaceURI)
Writes an empty element tag to the output
|
void |
XMLStreamWriter.writeEndDocument()
Closes any start tags and writes corresponding end tags.
|
void |
XMLStreamWriter.writeEndElement()
Writes an end tag to the output relying on the internal
state of the writer to determine the prefix and local name
of the event.
|
void |
XMLStreamWriter.writeEntityRef(String name)
Writes an entity reference
|
void |
XMLStreamWriter.writeNamespace(String prefix,
String namespaceURI)
Writes a namespace to the output stream
If the prefix argument to this method is the empty string,
"xmlns", or null this method will delegate to writeDefaultNamespace
|
void |
XMLStreamWriter.writeProcessingInstruction(String target)
Writes a processing instruction
|
void |
XMLStreamWriter.writeProcessingInstruction(String target,
String data)
Writes a processing instruction
|
void |
XMLStreamWriter.writeStartDocument()
Write the XML Declaration.
|
void |
XMLStreamWriter.writeStartDocument(String version)
Write the XML Declaration.
|
void |
XMLStreamWriter.writeStartDocument(String encoding,
String version)
Write the XML Declaration.
|
void |
XMLStreamWriter.writeStartElement(String localName)
Writes a start tag to the output.
|
void |
XMLStreamWriter.writeStartElement(String namespaceURI,
String localName)
Writes a start tag to the output
|
void |
XMLStreamWriter.writeStartElement(String prefix,
String localName,
String namespaceURI)
Writes a start tag to the output
|
Modifier and Type | Method and Description |
---|---|
void |
XMLEvent.writeAsEncodedUnicode(Writer writer)
This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.
|
Modifier and Type | Method and Description |
---|---|
void |
XMLEventConsumer.add(XMLEvent event)
This method adds an event to the consumer.
|
XMLEvent |
XMLEventAllocator.allocate(XMLStreamReader reader)
This method allocates an event given the current
state of the XMLStreamReader.
|
void |
XMLEventAllocator.allocate(XMLStreamReader reader,
XMLEventConsumer consumer)
This method allocates an event or set of events
given the current
state of the XMLStreamReader and adds the event
or set of events to the
consumer that was passed in.
|
void |
StreamReaderDelegate.close() |
void |
EventReaderDelegate.close() |
String |
StreamReaderDelegate.getElementText() |
String |
EventReaderDelegate.getElementText() |
int |
StreamReaderDelegate.getTextCharacters(int sourceStart,
char[] target,
int targetStart,
int length) |
boolean |
StreamReaderDelegate.hasNext() |
int |
StreamReaderDelegate.next() |
XMLEvent |
EventReaderDelegate.nextEvent() |
int |
StreamReaderDelegate.nextTag() |
XMLEvent |
EventReaderDelegate.nextTag() |
XMLEvent |
EventReaderDelegate.peek() |
void |
StreamReaderDelegate.require(int type,
String namespaceURI,
String localName) |
Constructor and Description |
---|
StAXSource(XMLEventReader xmlEventReader)
Creates a new instance of a
StAXSource
by supplying an XMLEventReader . |
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2023, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.