Streaming API for XML (JSR 173)
Version 1.0
A C D E F G H I J L N P R S W X

A

ALLOCATOR - Static variable in class javax.xml.stream.XMLInputFactory
The property used to set/get the implementation of the allocator
ATTRIBUTE - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates an event is an attribute
Attribute - interface javax.xml.stream.events.Attribute.
An interface that contains information about an attribute.
accept(XMLEvent) - Method in interface javax.xml.stream.EventFilter
Tests whether this event is part of this stream.
accept(XMLStreamReader) - Method in interface javax.xml.stream.StreamFilter
Tests whether the current state is part of this stream.
add(XMLEvent) - Method in 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.
add(XMLEventReader) - Method in 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.
add(XMLEvent) - Method in interface javax.xml.stream.util.XMLEventConsumer
This method adds an event to the consumer.
allocate(XMLStreamReader) - Method in interface javax.xml.stream.util.XMLEventAllocator
This method allocates an event given the current state of the XMLStreamReader.
allocate(XMLStreamReader, XMLEventConsumer) - Method in interface javax.xml.stream.util.XMLEventAllocator
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.
asCharacters() - Method in interface javax.xml.stream.events.XMLEvent
Returns this event as Characters, may result in a class cast exception if this event is not Characters.
asEndElement() - Method in interface javax.xml.stream.events.XMLEvent
Returns this event as an end element event, may result in a class cast exception if this event is not a end element.
asStartElement() - Method in interface javax.xml.stream.events.XMLEvent
Returns this event as a start element event, may result in a class cast exception if this event is not a start element.

C

CDATA - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates an event is a CDATA section
CHARACTERS - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates an event is characters
COMMENT - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates an event is a comment
Characters - interface javax.xml.stream.events.Characters.
This describes the interface to Characters events.
Comment - interface javax.xml.stream.events.Comment.
An interface for comment events
close() - Method in interface javax.xml.stream.XMLEventReader
Frees any resources associated with this Reader.
close() - Method in interface javax.xml.stream.XMLEventWriter
Frees any resources associated with this stream
close() - Method in interface javax.xml.stream.XMLStreamReader
Frees any resources associated with this Reader.
close() - Method in interface javax.xml.stream.XMLStreamWriter
Close this writer and free any resources associated with the writer.
close() - Method in class javax.xml.stream.util.EventReaderDelegate
 
close() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
createAttribute(String, String, String, String) - Method in class javax.xml.stream.XMLEventFactory
Create a new Attribute
createAttribute(String, String) - Method in class javax.xml.stream.XMLEventFactory
Create a new Attribute
createAttribute(QName, String) - Method in class javax.xml.stream.XMLEventFactory
Create a new Attribute
createCData(String) - Method in class javax.xml.stream.XMLEventFactory
Create a Characters event with the CData flag set to true
createCharacters(String) - Method in class javax.xml.stream.XMLEventFactory
Create a Characters event, this method does not check if the content is all whitespace.
createComment(String) - Method in class javax.xml.stream.XMLEventFactory
Create a comment
createDTD(String) - Method in class javax.xml.stream.XMLEventFactory
Create a document type definition event This string contains the entire document type declaration that matches the doctypedecl in the XML 1.0 specification
createEndDocument() - Method in class javax.xml.stream.XMLEventFactory
Creates a new instance of an EndDocument event
createEndElement(QName, Iterator) - Method in class javax.xml.stream.XMLEventFactory
Create a new EndElement
createEndElement(String, String, String) - Method in class javax.xml.stream.XMLEventFactory
Create a new EndElement
createEndElement(String, String, String, Iterator) - Method in class javax.xml.stream.XMLEventFactory
Create a new EndElement
createEntityReference(String, EntityDeclaration) - Method in class javax.xml.stream.XMLEventFactory
Creates a new instance of a EntityReference event
createFilteredReader(XMLStreamReader, StreamFilter) - Method in class javax.xml.stream.XMLInputFactory
Create a filtered reader that wraps the filter around the reader
createFilteredReader(XMLEventReader, EventFilter) - Method in class javax.xml.stream.XMLInputFactory
Create a filtered event reader that wraps the filter around the event reader
createIgnorableSpace(String) - Method in class javax.xml.stream.XMLEventFactory
Create an ignorable space
createNamespace(String) - Method in class javax.xml.stream.XMLEventFactory
Create a new default Namespace
createNamespace(String, String) - Method in class javax.xml.stream.XMLEventFactory
Create a new Namespace
createProcessingInstruction(String, String) - Method in class javax.xml.stream.XMLEventFactory
Create a processing instruction
createSpace(String) - Method in class javax.xml.stream.XMLEventFactory
Create a Characters event with the isSpace flag set to true
createStartDocument() - Method in class javax.xml.stream.XMLEventFactory
Creates a new instance of a StartDocument event
createStartDocument(String, String, boolean) - Method in class javax.xml.stream.XMLEventFactory
Creates a new instance of a StartDocument event
createStartDocument(String, String) - Method in class javax.xml.stream.XMLEventFactory
Creates a new instance of a StartDocument event
createStartDocument(String) - Method in class javax.xml.stream.XMLEventFactory
Creates a new instance of a StartDocument event
createStartElement(QName, Iterator, Iterator) - Method in class javax.xml.stream.XMLEventFactory
Create a new StartElement.
createStartElement(String, String, String) - Method in class javax.xml.stream.XMLEventFactory
Create a new StartElement.
createStartElement(String, String, String, Iterator, Iterator) - Method in class javax.xml.stream.XMLEventFactory
Create a new StartElement.
createStartElement(String, String, String, Iterator, Iterator, NamespaceContext) - Method in class javax.xml.stream.XMLEventFactory
Create a new StartElement.
createXMLEventReader(Reader) - Method in class javax.xml.stream.XMLInputFactory
Create a new XMLEventReader from a reader
createXMLEventReader(String, Reader) - Method in class javax.xml.stream.XMLInputFactory
Create a new XMLEventReader from a reader
createXMLEventReader(XMLStreamReader) - Method in class javax.xml.stream.XMLInputFactory
Create a new XMLEventReader from an XMLStreamReader.
createXMLEventReader(Source) - Method in class javax.xml.stream.XMLInputFactory
Create a new XMLEventReader from a JAXP source.
createXMLEventReader(InputStream) - Method in class javax.xml.stream.XMLInputFactory
Create a new XMLEventReader from a java.io.InputStream
createXMLEventReader(InputStream, String) - Method in class javax.xml.stream.XMLInputFactory
Create a new XMLEventReader from a java.io.InputStream
createXMLEventReader(String, InputStream) - Method in class javax.xml.stream.XMLInputFactory
Create a new XMLEventReader from a java.io.InputStream
createXMLEventWriter(Result) - Method in class javax.xml.stream.XMLOutputFactory
Create a new XMLEventWriter that writes to a JAXP result.
createXMLEventWriter(OutputStream) - Method in class javax.xml.stream.XMLOutputFactory
Create a new XMLEventWriter that writes to a stream
createXMLEventWriter(OutputStream, String) - Method in class javax.xml.stream.XMLOutputFactory
Create a new XMLEventWriter that writes to a stream
createXMLEventWriter(Writer) - Method in class javax.xml.stream.XMLOutputFactory
Create a new XMLEventWriter that writes to a writer
createXMLStreamReader(Reader) - Method in class javax.xml.stream.XMLInputFactory
Create a new XMLStreamReader from a reader
createXMLStreamReader(Source) - Method in class javax.xml.stream.XMLInputFactory
Create a new XMLStreamReader from a JAXP source.
createXMLStreamReader(InputStream) - Method in class javax.xml.stream.XMLInputFactory
Create a new XMLStreamReader from a java.io.InputStream
createXMLStreamReader(InputStream, String) - Method in class javax.xml.stream.XMLInputFactory
Create a new XMLStreamReader from a java.io.InputStream
createXMLStreamReader(String, InputStream) - Method in class javax.xml.stream.XMLInputFactory
Create a new XMLStreamReader from a java.io.InputStream
createXMLStreamReader(String, Reader) - Method in class javax.xml.stream.XMLInputFactory
Create a new XMLStreamReader from a java.io.InputStream
createXMLStreamWriter(Writer) - Method in class javax.xml.stream.XMLOutputFactory
Create a new XMLStreamWriter that writes to a writer
createXMLStreamWriter(OutputStream) - Method in class javax.xml.stream.XMLOutputFactory
Create a new XMLStreamWriter that writes to a stream
createXMLStreamWriter(OutputStream, String) - Method in class javax.xml.stream.XMLOutputFactory
Create a new XMLStreamWriter that writes to a stream
createXMLStreamWriter(Result) - Method in class javax.xml.stream.XMLOutputFactory
Create a new XMLStreamWriter that writes to a JAXP result.

D

DTD - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates an event is a DTD
DTD - interface javax.xml.stream.events.DTD.
This is the top level interface for events dealing with DTDs

E

END_DOCUMENT - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates an event is an end document
END_ELEMENT - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates an event is an end element
ENTITY_DECLARATION - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates a Entity Declaration
ENTITY_REFERENCE - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates an event is an entity reference
EndDocument - interface javax.xml.stream.events.EndDocument.
A marker interface for the end of the document
EndElement - interface javax.xml.stream.events.EndElement.
An interface for the end element event.
EntityDeclaration - interface javax.xml.stream.events.EntityDeclaration.
An interface for handling Entity Declarations This interface is used to record and report unparsed entity declarations.
EntityReference - interface javax.xml.stream.events.EntityReference.
An interface for handling Entity events.
EventFilter - interface javax.xml.stream.EventFilter.
This interface declares a simple filter interface that one can create to filter XMLEventReaders
EventReaderDelegate - class javax.xml.stream.util.EventReaderDelegate.
This is the base class for deriving an XMLEventReader filter.
EventReaderDelegate() - Constructor for class javax.xml.stream.util.EventReaderDelegate
Construct an empty filter with no parent.
EventReaderDelegate(XMLEventReader) - Constructor for class javax.xml.stream.util.EventReaderDelegate
Construct an filter with the specified parent.
encodingSet() - Method in interface javax.xml.stream.events.StartDocument
Returns true if CharacterEncodingScheme was set in the encoding declaration of the document

F

FactoryConfigurationError - error javax.xml.stream.FactoryConfigurationError.
An error class for reporting factory configuration errors.
FactoryConfigurationError() - Constructor for class javax.xml.stream.FactoryConfigurationError
Default constructor
FactoryConfigurationError(Exception) - Constructor for class javax.xml.stream.FactoryConfigurationError
Construct an exception with a nested inner exception
FactoryConfigurationError(Exception, String) - Constructor for class javax.xml.stream.FactoryConfigurationError
Construct an exception with a nested inner exception and a message
FactoryConfigurationError(String, Exception) - Constructor for class javax.xml.stream.FactoryConfigurationError
Construct an exception with a nested inner exception and a message
FactoryConfigurationError(String) - Constructor for class javax.xml.stream.FactoryConfigurationError
Construct an exception with associated message
flush() - Method in interface javax.xml.stream.XMLEventWriter
Writes any cached events to the underlying output mechanism
flush() - Method in interface javax.xml.stream.XMLStreamWriter
Write any cached data to the underlying output mechanism.

G

getAttributeByName(QName) - Method in interface javax.xml.stream.events.StartElement
Returns the attribute referred to by this name
getAttributeCount() - Method in interface javax.xml.stream.XMLStreamReader
Returns the count of attributes on this START_ELEMENT, this method is only valid on a START_ELEMENT or ATTRIBUTE.
getAttributeCount() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getAttributeLocalName(int) - Method in interface javax.xml.stream.XMLStreamReader
Returns the localName of the attribute at the provided index
getAttributeLocalName(int) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getAttributeName(int) - Method in interface javax.xml.stream.XMLStreamReader
Returns the qname of the attribute at the provided index
getAttributeName(int) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getAttributeNamespace(int) - Method in interface javax.xml.stream.XMLStreamReader
Returns the namespace of the attribute at the provided index
getAttributeNamespace(int) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getAttributePrefix(int) - Method in interface javax.xml.stream.XMLStreamReader
Returns the prefix of this attribute at the provided index
getAttributePrefix(int) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getAttributeType(int) - Method in interface javax.xml.stream.XMLStreamReader
Returns the XML type of the attribute at the provided index
getAttributeType(int) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getAttributeValue(String, String) - Method in interface javax.xml.stream.XMLStreamReader
Returns the normalized attribute value of the attribute with the namespace and localName If the namespaceURI is null the namespace is not checked for equality
getAttributeValue(int) - Method in interface javax.xml.stream.XMLStreamReader
Returns the value of the attribute at the index
getAttributeValue(String, String) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getAttributeValue(int) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getAttributes() - Method in interface javax.xml.stream.events.StartElement
Returns an Iterator of non-namespace declared attributes declared on this START_ELEMENT, returns an empty iterator if there are no attributes.
getBaseURI() - Method in interface javax.xml.stream.events.EntityDeclaration
Get the base URI for this reference or null if this information is not available
getCharacterEncodingScheme() - Method in interface javax.xml.stream.XMLStreamReader
Returns the character encoding declared on the xml declaration Returns null if none was declared
getCharacterEncodingScheme() - Method in interface javax.xml.stream.events.StartDocument
Returns the encoding style of the XML data
getCharacterEncodingScheme() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getCharacterOffset() - Method in interface javax.xml.stream.Location
Return the byte or character offset into the input source this location is pointing to.
getColumnNumber() - Method in interface javax.xml.stream.Location
Return the column number where the current event ends, returns -1 if none is available.
getDTDType() - Method in interface javax.xml.stream.events.Attribute
Gets the type of this attribute, default is the String "CDATA"
getData() - Method in interface javax.xml.stream.events.Characters
Get the character data of this event
getData() - Method in interface javax.xml.stream.events.ProcessingInstruction
The data section of the processing instruction
getDeclaration() - Method in interface javax.xml.stream.events.EntityReference
Return the declaration of this entity.
getDocumentTypeDeclaration() - Method in interface javax.xml.stream.events.DTD
Returns the entire Document Type Declaration as a string, including the internal DTD subset.
getElementText() - Method in interface javax.xml.stream.XMLEventReader
Reads the content of a text-only element.
getElementText() - Method in interface javax.xml.stream.XMLStreamReader
Reads the content of a text-only element, an exception is thrown if this is not a text-only element.
getElementText() - Method in class javax.xml.stream.util.EventReaderDelegate
 
getElementText() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getEncoding() - Method in interface javax.xml.stream.XMLStreamReader
Return input encoding if known or null if unknown.
getEncoding() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getEntities() - Method in interface javax.xml.stream.events.DTD
Return a List containing the general entities, both external and internal, declared in the DTD.
getEventAllocator() - Method in class javax.xml.stream.XMLInputFactory
Gets the allocator used by streams created with this factory
getEventType() - Method in interface javax.xml.stream.XMLStreamReader
Returns an integer code that indicates the type of the event the cursor is pointing to.
getEventType() - Method in interface javax.xml.stream.events.XMLEvent
Returns an integer code for this event.
getEventType() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getException() - Method in class javax.xml.stream.FactoryConfigurationError
Return the nested exception (if any)
getLineNumber() - Method in interface javax.xml.stream.Location
Return the line number where the current event ends, returns -1 if none is available.
getLocalName() - Method in interface javax.xml.stream.XMLStreamReader
Returns the (local) name of the current event.
getLocalName() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getLocation() - Method in class javax.xml.stream.XMLStreamException
Gets the location of the exception
getLocation() - Method in interface javax.xml.stream.XMLStreamReader
Return the current location of the processor.
getLocation() - Method in interface javax.xml.stream.events.XMLEvent
Return the location of this event.
getLocation() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getMessage() - Method in class javax.xml.stream.FactoryConfigurationError
Report the message associated with this error
getName() - Method in interface javax.xml.stream.XMLStreamReader
Returns a QName for the current START_ELEMENT or END_ELEMENT event
getName() - Method in interface javax.xml.stream.events.Attribute
Returns the QName for this attribute
getName() - Method in interface javax.xml.stream.events.EndElement
Get the name of this event
getName() - Method in interface javax.xml.stream.events.EntityDeclaration
The entity's name
getName() - Method in interface javax.xml.stream.events.EntityReference
The name of the entity
getName() - Method in interface javax.xml.stream.events.NotationDeclaration
The notation name.
getName() - Method in interface javax.xml.stream.events.StartElement
Get the name of this event
getName() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getNamespaceContext() - Method in interface javax.xml.stream.XMLEventWriter
Returns the current namespace context.
getNamespaceContext() - Method in interface javax.xml.stream.XMLStreamReader
Returns a read only namespace context for the current position.
getNamespaceContext() - Method in interface javax.xml.stream.XMLStreamWriter
Returns the current namespace context.
getNamespaceContext() - Method in interface javax.xml.stream.events.StartElement
Gets a read-only namespace context.
getNamespaceContext() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getNamespaceCount() - Method in interface javax.xml.stream.XMLStreamReader
Returns the count of namespaces declared on this START_ELEMENT or END_ELEMENT, this method is only valid on a START_ELEMENT, END_ELEMENT or NAMESPACE.
getNamespaceCount() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getNamespacePrefix(int) - Method in interface javax.xml.stream.XMLStreamReader
Returns the prefix for the namespace declared at the index.
getNamespacePrefix(int) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getNamespaceURI(String) - Method in interface javax.xml.stream.XMLStreamReader
Return the uri for the given prefix.
getNamespaceURI(int) - Method in interface javax.xml.stream.XMLStreamReader
Returns the uri for the namespace declared at the index.
getNamespaceURI() - Method in interface javax.xml.stream.XMLStreamReader
If the current event is a START_ELEMENT or END_ELEMENT this method returns the URI of the prefix or the default namespace.
getNamespaceURI() - Method in interface javax.xml.stream.events.Namespace
Gets the uri bound to the prefix of this namespace
getNamespaceURI(String) - Method in interface javax.xml.stream.events.StartElement
Gets the value that the prefix is bound to in the context of this element.
getNamespaceURI(String) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getNamespaceURI(int) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getNamespaceURI() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getNamespaces() - Method in interface javax.xml.stream.events.EndElement
Returns an Iterator of namespaces that have gone out of scope.
getNamespaces() - Method in interface javax.xml.stream.events.StartElement
Returns an Iterator of namespaces declared on this element.
getNestedException() - Method in class javax.xml.stream.XMLStreamException
Gets the nested exception.
getNotationName() - Method in interface javax.xml.stream.events.EntityDeclaration
The name of the associated notation.
getNotations() - Method in interface javax.xml.stream.events.DTD
Return a List containing the notations declared in the DTD.
getPIData() - Method in interface javax.xml.stream.XMLStreamReader
Get the data section of a processing instruction
getPIData() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getPITarget() - Method in interface javax.xml.stream.XMLStreamReader
Get the target of a processing instruction
getPITarget() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getParent() - Method in class javax.xml.stream.util.EventReaderDelegate
Get the parent of this instance.
getParent() - Method in class javax.xml.stream.util.StreamReaderDelegate
Get the parent of this instance.
getPrefix(String) - Method in interface javax.xml.stream.XMLEventWriter
Gets the prefix the uri is bound to
getPrefix() - Method in interface javax.xml.stream.XMLStreamReader
Returns the prefix of the current event or null if the event does not have a prefix
getPrefix(String) - Method in interface javax.xml.stream.XMLStreamWriter
Gets the prefix the uri is bound to
getPrefix() - Method in interface javax.xml.stream.events.Namespace
Gets the prefix, returns "" if this is a default namespace declaration.
getPrefix() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getProcessedDTD() - Method in interface javax.xml.stream.events.DTD
Returns an implementation defined representation of the DTD.
getProperty(String) - Method in interface javax.xml.stream.XMLEventReader
Get the value of a feature/property from the underlying implementation
getProperty(String) - Method in class javax.xml.stream.XMLInputFactory
Get the value of a feature/property from the underlying implementation
getProperty(String) - Method in class javax.xml.stream.XMLOutputFactory
Get a feature/property on the underlying implementation
getProperty(String) - Method in interface javax.xml.stream.XMLStreamReader
Get the value of a feature/property from the underlying implementation
getProperty(String) - Method in interface javax.xml.stream.XMLStreamWriter
Get the value of a feature/property from the underlying implementation
getProperty(String) - Method in class javax.xml.stream.util.EventReaderDelegate
 
getProperty(String) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getPublicId() - Method in interface javax.xml.stream.Location
Returns the public ID of the XML
getPublicId() - Method in interface javax.xml.stream.events.EntityDeclaration
The entity's public identifier, or null if none was given
getPublicId() - Method in interface javax.xml.stream.events.NotationDeclaration
The notation's public identifier, or null if none was given.
getReplacementText() - Method in interface javax.xml.stream.events.EntityDeclaration
The replacement text of the entity.
getSchemaType() - Method in interface javax.xml.stream.events.XMLEvent
This method is provided for implementations to provide optional type information about the associated event.
getSystemId() - Method in interface javax.xml.stream.Location
Returns the system ID of the XML
getSystemId() - Method in interface javax.xml.stream.events.EntityDeclaration
The entity's system identifier.
getSystemId() - Method in interface javax.xml.stream.events.NotationDeclaration
The notation's system identifier, or null if none was given.
getSystemId() - Method in interface javax.xml.stream.events.StartDocument
Returns the system ID of the XML data
getTarget() - Method in interface javax.xml.stream.events.ProcessingInstruction
The target section of the processing instruction
getText() - Method in interface javax.xml.stream.XMLStreamReader
Returns the current value of the parse event as a string, this returns the string value of a CHARACTERS event, returns the value of a COMMENT, the replacement value for an ENTITY_REFERENCE, the string value of a CDATA section, the string value for a SPACE event, or the String value of the internal subset of the DTD.
getText() - Method in interface javax.xml.stream.events.Comment
Return the string data of the comment, returns empty string if it does not exist
getText() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getTextCharacters() - Method in interface javax.xml.stream.XMLStreamReader
Returns an array which contains the characters from this event.
getTextCharacters(int, char[], int, int) - Method in interface javax.xml.stream.XMLStreamReader
Gets the the text associated with a CHARACTERS, SPACE or CDATA event.
getTextCharacters(int, char[], int, int) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getTextCharacters() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getTextLength() - Method in interface javax.xml.stream.XMLStreamReader
Returns the length of the sequence of characters for this Text event within the text character array.
getTextLength() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getTextStart() - Method in interface javax.xml.stream.XMLStreamReader
Returns the offset into the text character array where the first character (of this text event) is stored.
getTextStart() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getValue() - Method in interface javax.xml.stream.events.Attribute
Gets the normalized value of this attribute
getVersion() - Method in interface javax.xml.stream.XMLStreamReader
Get the xml version declared on the xml declaration Returns null if none was declared
getVersion() - Method in interface javax.xml.stream.events.StartDocument
Returns the version of XML of this XML stream
getVersion() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
getXMLReporter() - Method in class javax.xml.stream.XMLInputFactory
The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
getXMLResolver() - Method in class javax.xml.stream.XMLInputFactory
The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

H

hasName() - Method in interface javax.xml.stream.XMLStreamReader
returns true if the current event has a name (is a START_ELEMENT or END_ELEMENT) returns false otherwise
hasName() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
hasNext() - Method in interface javax.xml.stream.XMLEventReader
Check if there are more events.
hasNext() - Method in interface javax.xml.stream.XMLStreamReader
Returns true if there are more parsing events and false if there are no more events.
hasNext() - Method in class javax.xml.stream.util.EventReaderDelegate
 
hasNext() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
hasText() - Method in interface javax.xml.stream.XMLStreamReader
Return true if the current event has text, false otherwise The following events have text: CHARACTERS,DTD ,ENTITY_REFERENCE, COMMENT, SPACE
hasText() - Method in class javax.xml.stream.util.StreamReaderDelegate
 

I

IS_COALESCING - Static variable in class javax.xml.stream.XMLInputFactory
The property that requires the parser to coalesce adjacent character data sections
IS_NAMESPACE_AWARE - Static variable in class javax.xml.stream.XMLInputFactory
The property used to turn on/off namespace support, this is to support XML 1.0 documents, only the true setting must be supported
IS_REPAIRING_NAMESPACES - Static variable in class javax.xml.stream.XMLOutputFactory
Property used to set prefix defaulting on the output side
IS_REPLACING_ENTITY_REFERENCES - Static variable in class javax.xml.stream.XMLInputFactory
Requires the parser to replace internal entity references with their replacement text and report them as characters
IS_SUPPORTING_EXTERNAL_ENTITIES - Static variable in class javax.xml.stream.XMLInputFactory
The property that requires the parser to resolve external parsed entities
IS_VALIDATING - Static variable in class javax.xml.stream.XMLInputFactory
The property used to turn on/off implementation specific validation
isAttribute() - Method in interface javax.xml.stream.events.XMLEvent
A utility function to check if this event is an Attribute.
isAttributeSpecified(int) - Method in interface javax.xml.stream.XMLStreamReader
Returns a boolean which indicates if this attribute was created by default
isAttributeSpecified(int) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
isCData() - Method in interface javax.xml.stream.events.Characters
Returns true if this is a CData section.
isCharacters() - Method in interface javax.xml.stream.XMLStreamReader
Returns true if the cursor points to a character data event
isCharacters() - Method in interface javax.xml.stream.events.XMLEvent
A utility function to check if this event is Characters.
isCharacters() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
isDefaultNamespaceDeclaration() - Method in interface javax.xml.stream.events.Namespace
returns true if this attribute declares the default namespace
isEndDocument() - Method in interface javax.xml.stream.events.XMLEvent
A utility function to check if this event is an EndDocument.
isEndElement() - Method in interface javax.xml.stream.XMLStreamReader
Returns true if the cursor points to an end tag (otherwise false)
isEndElement() - Method in interface javax.xml.stream.events.XMLEvent
A utility function to check if this event is a EndElement.
isEndElement() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
isEntityReference() - Method in interface javax.xml.stream.events.XMLEvent
A utility function to check if this event is an EntityReference.
isIgnorableWhiteSpace() - Method in interface javax.xml.stream.events.Characters
Return true if this is ignorableWhiteSpace.
isNamespace() - Method in interface javax.xml.stream.events.XMLEvent
A utility function to check if this event is a Namespace.
isProcessingInstruction() - Method in interface javax.xml.stream.events.XMLEvent
A utility function to check if this event is a ProcessingInstruction.
isPropertySupported(String) - Method in class javax.xml.stream.XMLInputFactory
Query the set of properties that this factory supports.
isPropertySupported(String) - Method in class javax.xml.stream.XMLOutputFactory
Query the set of properties that this factory supports.
isSpecified() - Method in interface javax.xml.stream.events.Attribute
A flag indicating whether this attribute was actually specified in the start-tag of its element, or was defaulted from the schema.
isStandalone() - Method in interface javax.xml.stream.XMLStreamReader
Get the standalone declaration from the xml declaration
isStandalone() - Method in interface javax.xml.stream.events.StartDocument
Returns if this XML is standalone
isStandalone() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
isStartDocument() - Method in interface javax.xml.stream.events.XMLEvent
A utility function to check if this event is a StartDocument.
isStartElement() - Method in interface javax.xml.stream.XMLStreamReader
Returns true if the cursor points to a start tag (otherwise false)
isStartElement() - Method in interface javax.xml.stream.events.XMLEvent
A utility function to check if this event is a StartElement.
isStartElement() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
isWhiteSpace() - Method in interface javax.xml.stream.XMLStreamReader
Returns true if the cursor points to a character data event that consists of all whitespace
isWhiteSpace() - Method in interface javax.xml.stream.events.Characters
Returns true if this set of Characters is all whitespace.
isWhiteSpace() - Method in class javax.xml.stream.util.StreamReaderDelegate
 

J

javax.xml.stream - package javax.xml.stream
Provides an API for processing XML as a stream
javax.xml.stream.events - package javax.xml.stream.events
Describes a set of events for processing XML
javax.xml.stream.util - package javax.xml.stream.util
Provides various utilities for processing XML

L

Location - interface javax.xml.stream.Location.
Provides information on the location of an event.
location - Variable in class javax.xml.stream.XMLStreamException
 

N

NAMESPACE - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates the event is a namespace declaration
NOTATION_DECLARATION - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates a Notation
Namespace - interface javax.xml.stream.events.Namespace.
An interface that contains information about a namespace.
NotationDeclaration - interface javax.xml.stream.events.NotationDeclaration.
An interface for handling Notation Declarations Receive notification of a notation declaration event.
nested - Variable in class javax.xml.stream.XMLStreamException
 
newInstance() - Static method in class javax.xml.stream.XMLEventFactory
Create a new instance of the factory
newInstance(String, ClassLoader) - Static method in class javax.xml.stream.XMLEventFactory
Create a new instance of the factory
newInstance() - Static method in class javax.xml.stream.XMLInputFactory
Create a new instance of the factory.
newInstance(String, ClassLoader) - Static method in class javax.xml.stream.XMLInputFactory
Create a new instance of the factory
newInstance() - Static method in class javax.xml.stream.XMLOutputFactory
Create a new instance of the factory.
newInstance(String, ClassLoader) - Static method in class javax.xml.stream.XMLOutputFactory
Create a new instance of the factory
newInstance() - Method in interface javax.xml.stream.util.XMLEventAllocator
This method creates an instance of the XMLEventAllocator.
next() - Method in interface javax.xml.stream.XMLStreamReader
Get next parsing event - a processor may return all contiguous character data in a single chunk, or it may split it into several chunks.
next() - Method in class javax.xml.stream.util.EventReaderDelegate
 
next() - Method in class javax.xml.stream.util.StreamReaderDelegate
 
nextEvent() - Method in interface javax.xml.stream.XMLEventReader
Get the next XMLEvent
nextEvent() - Method in class javax.xml.stream.util.EventReaderDelegate
 
nextTag() - Method in interface javax.xml.stream.XMLEventReader
Skips any insignificant space events until a START_ELEMENT or END_ELEMENT is reached.
nextTag() - Method in interface javax.xml.stream.XMLStreamReader
Skips any white space (isWhiteSpace() returns true), COMMENT, or PROCESSING_INSTRUCTION, until a START_ELEMENT or END_ELEMENT is reached.
nextTag() - Method in class javax.xml.stream.util.EventReaderDelegate
 
nextTag() - Method in class javax.xml.stream.util.StreamReaderDelegate
 

P

PROCESSING_INSTRUCTION - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates an event is a processing instruction
ProcessingInstruction - interface javax.xml.stream.events.ProcessingInstruction.
An interface that describes the data found in processing instructions
peek() - Method in interface javax.xml.stream.XMLEventReader
Check the next XMLEvent without reading it from the stream.
peek() - Method in class javax.xml.stream.util.EventReaderDelegate
 

R

REPORTER - Static variable in class javax.xml.stream.XMLInputFactory
The property used to set/get the implementation of the XMLReporter interface
RESOLVER - Static variable in class javax.xml.stream.XMLInputFactory
The property used to set/get the implementation of the XMLResolver
remove() - Method in class javax.xml.stream.util.EventReaderDelegate
 
report(String, String, Object, Location) - Method in interface javax.xml.stream.XMLReporter
Report the desired message in an application specific format.
require(int, String, String) - Method in interface javax.xml.stream.XMLStreamReader
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.
require(int, String, String) - Method in class javax.xml.stream.util.StreamReaderDelegate
 
resolveEntity(String, String, String, String) - Method in interface javax.xml.stream.XMLResolver
Retrieves a resource.

S

SPACE - Static variable in interface javax.xml.stream.XMLStreamConstants
The characters are white space (see [XML], 2.10 "White Space Handling").
START_DOCUMENT - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates an event is a start document
START_ELEMENT - Static variable in interface javax.xml.stream.XMLStreamConstants
Indicates an event is a start element
SUPPORT_DTD - Static variable in class javax.xml.stream.XMLInputFactory
The property that requires the parser to support DTDs
StartDocument - interface javax.xml.stream.events.StartDocument.
An interface for the start document event
StartElement - interface javax.xml.stream.events.StartElement.
The StartElement interface provides access to information about start elements.
StreamFilter - interface javax.xml.stream.StreamFilter.
This interface declares a simple filter interface that one can create to filter XMLStreamReaders
StreamReaderDelegate - class javax.xml.stream.util.StreamReaderDelegate.
This is the base class for deriving an XMLStreamReader filter This class is designed to sit between an XMLStreamReader and an application's XMLStreamReader.
StreamReaderDelegate() - Constructor for class javax.xml.stream.util.StreamReaderDelegate
Construct an empty filter with no parent.
StreamReaderDelegate(XMLStreamReader) - Constructor for class javax.xml.stream.util.StreamReaderDelegate
Construct an filter with the specified parent.
setDefaultNamespace(String) - Method in 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.
setDefaultNamespace(String) - Method in interface javax.xml.stream.XMLStreamWriter
Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair.
setEventAllocator(XMLEventAllocator) - Method in class javax.xml.stream.XMLInputFactory
Set a user defined event allocator for events
setLocation(Location) - Method in class javax.xml.stream.XMLEventFactory
This method allows setting of the Location on each event that is created by this factory.
setNamespaceContext(NamespaceContext) - Method in interface javax.xml.stream.XMLEventWriter
Sets the current namespace context for prefix and uri bindings.
setNamespaceContext(NamespaceContext) - Method in interface javax.xml.stream.XMLStreamWriter
Sets the current namespace context for prefix and uri bindings.
setParent(XMLEventReader) - Method in class javax.xml.stream.util.EventReaderDelegate
Set the parent of this instance.
setParent(XMLStreamReader) - Method in class javax.xml.stream.util.StreamReaderDelegate
Set the parent of this instance.
setPrefix(String, String) - Method in interface javax.xml.stream.XMLEventWriter
Sets the prefix the uri is bound to.
setPrefix(String, String) - Method in interface javax.xml.stream.XMLStreamWriter
Sets the prefix the uri is bound to.
setProperty(String, Object) - Method in class javax.xml.stream.XMLInputFactory
Allows the user to set specific feature/property on the underlying implementation.
setProperty(String, Object) - Method in class javax.xml.stream.XMLOutputFactory
Allows the user to set specific features/properties on the underlying implementation.
setXMLReporter(XMLReporter) - Method in class javax.xml.stream.XMLInputFactory
The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
setXMLResolver(XMLResolver) - Method in class javax.xml.stream.XMLInputFactory
The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
standaloneSet() - Method in interface javax.xml.stream.XMLStreamReader
Checks if standalone was set in the document
standaloneSet() - Method in interface javax.xml.stream.events.StartDocument
Returns true if the standalone attribute was set in the encoding declaration of the document.
standaloneSet() - Method in class javax.xml.stream.util.StreamReaderDelegate
 

W

writeAsEncodedUnicode(Writer) - Method in interface javax.xml.stream.events.XMLEvent
This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.
writeAttribute(String, String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes an attribute to the output stream without a prefix.
writeAttribute(String, String, String, String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes an attribute to the output stream
writeAttribute(String, String, String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes an attribute to the output stream
writeCData(String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes a CData section
writeCharacters(String) - Method in interface javax.xml.stream.XMLStreamWriter
Write text to the output
writeCharacters(char[], int, int) - Method in interface javax.xml.stream.XMLStreamWriter
Write text to the output
writeComment(String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes an xml comment with the data enclosed
writeDTD(String) - Method in interface javax.xml.stream.XMLStreamWriter
Write a DTD section.
writeDefaultNamespace(String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes the default namespace to the stream
writeEmptyElement(String, String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes an empty element tag to the output
writeEmptyElement(String, String, String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes an empty element tag to the output
writeEmptyElement(String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes an empty element tag to the output
writeEndDocument() - Method in interface javax.xml.stream.XMLStreamWriter
Closes any start tags and writes corresponding end tags.
writeEndElement() - Method in interface javax.xml.stream.XMLStreamWriter
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.
writeEntityRef(String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes an entity reference
writeNamespace(String, String) - Method in interface javax.xml.stream.XMLStreamWriter
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
writeProcessingInstruction(String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes a processing instruction
writeProcessingInstruction(String, String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes a processing instruction
writeStartDocument() - Method in interface javax.xml.stream.XMLStreamWriter
Write the XML Declaration.
writeStartDocument(String) - Method in interface javax.xml.stream.XMLStreamWriter
Write the XML Declaration.
writeStartDocument(String, String) - Method in interface javax.xml.stream.XMLStreamWriter
Write the XML Declaration.
writeStartElement(String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes a start tag to the output.
writeStartElement(String, String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes a start tag to the output
writeStartElement(String, String, String) - Method in interface javax.xml.stream.XMLStreamWriter
Writes a start tag to the output

X

XMLEvent - interface javax.xml.stream.events.XMLEvent.
This is the base event interface for handling markup events.
XMLEventAllocator - interface javax.xml.stream.util.XMLEventAllocator.
This interface defines a class that allows a user to register a way to allocate events given an XMLStreamReader.
XMLEventConsumer - interface javax.xml.stream.util.XMLEventConsumer.
This interface defines an event consumer interface.
XMLEventFactory - class javax.xml.stream.XMLEventFactory.
This interface defines a utility class for creating instances of XMLEvents
XMLEventFactory() - Constructor for class javax.xml.stream.XMLEventFactory
 
XMLEventReader - interface javax.xml.stream.XMLEventReader.
This is the top level interface for parsing XML Events.
XMLEventWriter - interface javax.xml.stream.XMLEventWriter.
This is the top level interface for writing XML documents.
XMLInputFactory - class javax.xml.stream.XMLInputFactory.
Defines an abstract implementation of a factory for getting streams.
XMLInputFactory() - Constructor for class javax.xml.stream.XMLInputFactory
 
XMLOutputFactory - class javax.xml.stream.XMLOutputFactory.
Defines an abstract implementation of a factory for getting XMLEventWriters and XMLStreamWriters.
XMLOutputFactory() - Constructor for class javax.xml.stream.XMLOutputFactory
 
XMLReporter - interface javax.xml.stream.XMLReporter.
This interface is used to report non-fatal errors.
XMLResolver - interface javax.xml.stream.XMLResolver.
This interface is used to resolve resources during an XML parse.
XMLStreamConstants - interface javax.xml.stream.XMLStreamConstants.
This interface declares the constants used in this API.
XMLStreamException - exception javax.xml.stream.XMLStreamException.
The base exception for unexpected processing errors.
XMLStreamException() - Constructor for class javax.xml.stream.XMLStreamException
Default constructor
XMLStreamException(String) - Constructor for class javax.xml.stream.XMLStreamException
Construct an exception with the assocated message.
XMLStreamException(Throwable) - Constructor for class javax.xml.stream.XMLStreamException
Construct an exception with the assocated exception
XMLStreamException(String, Throwable) - Constructor for class javax.xml.stream.XMLStreamException
Construct an exception with the assocated message and exception
XMLStreamException(String, Location, Throwable) - Constructor for class javax.xml.stream.XMLStreamException
Construct an exception with the assocated message, exception and location.
XMLStreamException(String, Location) - Constructor for class javax.xml.stream.XMLStreamException
Construct an exception with the assocated message, exception and location.
XMLStreamReader - interface javax.xml.stream.XMLStreamReader.
The XMLStreamReader interface allows forward, read-only access to XML.
XMLStreamWriter - interface javax.xml.stream.XMLStreamWriter.
The XMLStreamWriter interface specifies how to write XML.

A C D E F G H I J L N P R S W X
Streaming API for XML (JSR 173)
Version 1.0