| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public int | getAttributeCount()
Implements javax. |
| public String | getAttributeLocalName(int
the position of the attribute n)Implements javax. |
| public QName | getAttributeName(int
the position of the attribute n)Implements javax. |
| public String | getAttributeNamespace(int
the position of the attribute n)Implements javax. |
| public String | getAttributePrefix(int
the position of the attribute n)Implements javax. |
| public String | getAttributeType(int
the position of the attribute index)Implements javax. |
| public String | getAttributeValue(int
the position of the attribute n)Implements javax. |
| public String | getAttributeValue(String
the namespace of the attribute ns, String the local name of the attribute, cannot be null local)Implements javax. |
| public String | getCharacterEncodingScheme()
Implements javax. |
| public String | getEncoding()
Implements javax. |
| public int | getEventType()
Implements javax. |
| public String | getLocalName()
Implements javax. |
| public Location | getLocation()
Implements javax. |
| public QName | getName()
Implements javax. |
| public int | getNamespaceCount()
Implements javax. |
| public String | getNamespacePrefix(int
the position of the namespace declaration n)Implements javax. |
| public String | getNamespaceURI()
Implements javax. |
| public String | getNamespaceURI(int
the position of the namespace declaration n)Implements javax. |
| public String | getNamespaceURI(String
The prefix to lookup, may not be null prefix)Implements javax. |
| public String | getPIData()
Implements javax. |
| public String | getPITarget()
Implements javax. |
| public String | getPrefix()
Implements javax. |
| public Object | getProperty(String
The name of the property, may not be null arg0)Implements javax. |
| public char[] | getTextCharacters()
Implements javax. |
| public int | getTextCharacters(int
the index of the first character in the source array to copy sourceStart, char[] the destination array target, int the start offset in the target array targetStart, int the number of characters to copy length)Implements javax. |
| public int | getTextLength()
Implements javax. |
| public int | getTextStart()
Implements javax. |
| public String | getVersion()
Implements javax. |
| public boolean | hasName()
Implements javax. |
| public boolean | hasNext()
Implements javax. |
| public boolean | hasText()
Implements javax. |
| public boolean | isAttributeSpecified(int
the position of the attribute index)Implements javax. |
| public boolean | isCharacters()
Implements javax. |
| public boolean | isEndElement()
Implements javax. |
| public boolean | isStandalone()
Implements javax. |
| public boolean | isStartElement()
Implements javax. |
| public boolean | isWhiteSpace()
Implements javax. |
| public int | nextTag()
Implements javax. |
| public void | require(int
the event type arg0, String the uri of the event, may be null arg1, String the localName of the event, may be null arg2)Implements javax. |
| public boolean | standaloneSet()
Implements javax. |
| AbstractXMLStreamReader | back to summary |
|---|---|
| public AbstractXMLStreamReader() | |
| getAttributeCount | back to summary |
|---|---|
| public int getAttributeCount() Implements javax. Doc from javax. Returns the count of attributes on this START_ELEMENT, this method is only valid on a START_ELEMENT or ATTRIBUTE. This count excludes namespace definitions. Attribute indices are zero-based.
| |
| getAttributeLocalName | back to summary |
|---|---|
| public String getAttributeLocalName(int n) Implements javax. Doc from javax. Returns the localName of the attribute at the provided index
| |
| getAttributeName | back to summary |
|---|---|
| public QName getAttributeName(int n) Implements javax. Doc from javax. Returns the qname of the attribute at the provided index
| |
| getAttributeNamespace | back to summary |
|---|---|
| public String getAttributeNamespace(int n) Implements javax. Doc from javax. Returns the namespace of the attribute at the provided index
| |
| getAttributePrefix | back to summary |
|---|---|
| public String getAttributePrefix(int n) Implements javax. Doc from javax. Returns the prefix of this attribute at the provided index
| |
| getAttributeType | back to summary |
|---|---|
| public String getAttributeType(int index) Implements javax. Doc from javax. Returns the XML type of the attribute at the provided index
| |
| getAttributeValue | back to summary |
|---|---|
| public String getAttributeValue(int n) Implements javax. Doc from javax. Returns the value of the attribute at the index
| |
| getAttributeValue | back to summary |
|---|---|
| public String getAttributeValue(String ns, String local) Implements javax. Doc from javax. 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 | |
| getCharacterEncodingScheme | back to summary |
|---|---|
| public String getCharacterEncodingScheme() Implements javax. Doc from javax. Returns the character encoding declared on the xml declaration Returns null if none was declared
| |
| getEncoding | back to summary |
|---|---|
| public String getEncoding() Implements javax. Doc from javax. Return input encoding if known or null if unknown.
| |
| getEventType | back to summary |
|---|---|
| public int getEventType() Implements javax. Doc from javax. Returns an integer code that indicates the type of the event the cursor is
pointing to. The initial event type is
| |
| getLocalName | back to summary |
|---|---|
| public String getLocalName() Implements javax. Doc from javax. Returns the (local) name of the current event. For START_ELEMENT or END_ELEMENT returns the (local) name of the current element. For ENTITY_REFERENCE it returns entity name. The current event must be START_ELEMENT or END_ELEMENT, or ENTITY_REFERENCE
| |
| getLocation | back to summary |
|---|---|
| public Location getLocation() Implements javax. Doc from javax. Return the current location of the processor. If the Location is unknown the processor should return an implementation of Location that returns -1 for the location and null for the publicId and systemId. The location information is only valid until next() is called.
| |
| getName | back to summary |
|---|---|
| public QName getName() Implements javax. Doc from javax. Returns a QName for the current START_ELEMENT or END_ELEMENT event
| |
| getNamespaceCount | back to summary |
|---|---|
| public int getNamespaceCount() Implements javax. Doc from javax. 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. On an END_ELEMENT the count is of the namespaces that are about to go out of scope. This is the equivalent of the information reported by SAX callback for an end element event.
| |
| getNamespacePrefix | back to summary |
|---|---|
| public String getNamespacePrefix(int n) Implements javax. Doc from javax. Returns the prefix for the namespace declared at the index. Returns null if this is the default namespace declaration
| |
| getNamespaceURI | back to summary |
|---|---|
| public String getNamespaceURI() Implements javax. Doc from javax. If the current event is a START_ELEMENT or END_ELEMENT this method returns the URI of the prefix or the default namespace. Returns null if the event does not have a prefix.
| |
| getNamespaceURI | back to summary |
|---|---|
| public String getNamespaceURI(int n) Implements javax. Doc from javax. Returns the uri for the namespace declared at the index.
| |
| getNamespaceURI | back to summary |
|---|---|
| public String getNamespaceURI(String prefix) Implements javax. Doc from javax. Return the uri for the given prefix. The uri returned depends on the current state of the processor. Note The 'xml' prefix is bound as defined in Namespaces in XML specification to "http://www.w3.org/XML/1998/namespace". Note The 'xmlns' prefix must be resolved to following namespace http://www.w3.org/2000/xmlns/ | |
| getPIData | back to summary |
|---|---|
| public String getPIData() Implements javax. Doc from javax. Get the data section of a processing instruction
| |
| getPITarget | back to summary |
|---|---|
| public String getPITarget() Implements javax. Doc from javax. Get the target of a processing instruction
| |
| getPrefix | back to summary |
|---|---|
| public String getPrefix() Implements javax. Doc from javax. Returns the prefix of the current event or null if the event does not have a prefix
| |
| getProperty | back to summary |
|---|---|
| public Object getProperty(String arg0) throws IllegalArgumentException Implements javax. Doc from javax. Get the value of a feature/property from the underlying implementation
| |
| getTextCharacters | back to summary |
|---|---|
| public char[] getTextCharacters() Implements javax. Doc from javax. Returns an array which contains the characters from this event. This array should be treated as read-only and transient. I.e. the array will contain the text characters until the XMLStreamReader moves on to the next event. Attempts to hold onto the character array beyond that time or modify the contents of the array are breaches of the contract for this interface.
| |
| getTextCharacters | back to summary |
|---|---|
| public int getTextCharacters(int sourceStart, char[] target, int targetStart, int length) throws XMLStreamException Implements javax. Doc from javax. Gets the text associated with a CHARACTERS, SPACE or CDATA event. Text starting a "sourceStart" is copied into "target" starting at "targetStart". Up to "length" characters are copied. The number of characters actually copied is returned. The "sourceStart" argument must be greater or equal to 0 and less than or equal to the number of characters associated with the event. Usually, one requests text starting at a "sourceStart" of 0. If the number of characters actually copied is less than the "length", then there is no more text. Otherwise, subsequent calls need to be made until all text has been retrieved. For example:
XMLStreamException may be thrown if there are any XML errors in the underlying source.
The "targetStart" argument must be greater than or equal to 0 and less than the length of "target",
Length must be greater than 0 and "targetStart + length" must be less than or equal to length of "target".
| |
| getTextLength | back to summary |
|---|---|
| public int getTextLength() Implements javax. Doc from javax. Returns the length of the sequence of characters for this Text event within the text character array.
| |
| getTextStart | back to summary |
|---|---|
| public int getTextStart() Implements javax. Doc from javax. Returns the offset into the text character array where the first character (of this text event) is stored.
| |
| getVersion | back to summary |
|---|---|
| public String getVersion() Implements javax. Doc from javax. Get the xml version declared on the xml declaration Returns null if none was declared
| |
| hasName | back to summary |
|---|---|
| public boolean hasName() Implements javax. Doc from javax. returns a boolean indicating whether the current event has a name (is a START_ELEMENT or END_ELEMENT).
| |
| hasNext | back to summary |
|---|---|
| public boolean hasNext() throws XMLStreamException Implements javax. Doc from javax. Returns true if there are more parsing events and false if there are no more events. This method will return false if the current state of the XMLStreamReader is END_DOCUMENT
| |
| hasText | back to summary |
|---|---|
| public boolean hasText() Implements javax. Doc from javax. Return a boolean indicating whether the current event has text. The following events have text: CHARACTERS,DTD ,ENTITY_REFERENCE, COMMENT, SPACE
| |
| isAttributeSpecified | back to summary |
|---|---|
| public boolean isAttributeSpecified(int index) Implements javax. Doc from javax. Returns a boolean which indicates if this attribute was created by default
| |
| isCharacters | back to summary |
|---|---|
| public boolean isCharacters() Implements javax. Doc from javax. Returns true if the cursor points to a character data event
| |
| isEndElement | back to summary |
|---|---|
| public boolean isEndElement() Implements javax. Doc from javax. Returns true if the cursor points to an end tag (otherwise false)
| |
| isStandalone | back to summary |
|---|---|
| public boolean isStandalone() Implements javax. Doc from javax. Get the standalone declaration from the xml declaration
| |
| isStartElement | back to summary |
|---|---|
| public boolean isStartElement() Implements javax. Doc from javax. Returns true if the cursor points to a start tag (otherwise false)
| |
| isWhiteSpace | back to summary |
|---|---|
| public boolean isWhiteSpace() Implements javax. Doc from javax. Returns true if the cursor points to a character data event that consists of all whitespace
| |
| nextTag | back to summary |
|---|---|
| public int nextTag() throws XMLStreamException Implements javax. Doc from javax. Skips any white space (isWhiteSpace() returns true), COMMENT,
or PROCESSING_INSTRUCTION,
until a START_ELEMENT or END_ELEMENT is reached.
If other than white space characters, COMMENT, PROCESSING_INSTRUCTION, START_ELEMENT, END_ELEMENT
are encountered, an exception is thrown. This method should
be used when processing element-only content separated by white space.
| |
| require | back to summary |
|---|---|
| public void require(int arg0, String arg1, String arg2) throws XMLStreamException Implements javax. Doc from javax. 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. If the namespaceURI is null it is not checked for equality, if the localName is null it is not checked for equality.
| |
| standaloneSet | back to summary |
|---|---|
| public boolean standaloneSet() Implements javax. Doc from javax. Checks if standalone was set in the document
| |