javax.xml.stream.events.StartElement |
Class Overview
The StartElement interface provides access to information about
start elements. A StartElement is reported for each Start Tag
in the document.
Summary
Public Methods |
abstract
Attribute
|
getAttributeByName(QName name)
Returns the attribute referred to by this name
|
abstract
Iterator
|
getAttributes()
Returns an Iterator of non-namespace declared attributes declared on
this START_ELEMENT,
returns an empty iterator if there are no attributes.
|
abstract
QName
|
getName()
Get the name of this event
|
abstract
NamespaceContext
|
getNamespaceContext()
Gets a read-only namespace context.
|
abstract
String
|
getNamespaceURI(String prefix)
Gets the value that the prefix is bound to in the
context of this element.
|
abstract
Iterator
|
getNamespaces()
Returns an Iterator of namespaces declared on this element.
|
[Expand]
Inherited Methods |
From interface
javax.xml.stream.events.XMLEvent
abstract
Characters
|
asCharacters()
Returns this event as Characters, may result in
a class cast exception if this event is not Characters.
|
abstract
EndElement
|
asEndElement()
Returns this event as an end element event, may result in
a class cast exception if this event is not a end element.
|
abstract
StartElement
|
asStartElement()
Returns this event as a start element event, may result in
a class cast exception if this event is not a start element.
|
abstract
int
|
getEventType()
Returns an integer code for this event.
|
abstract
Location
|
getLocation()
Return the location of this event.
|
abstract
QName
|
getSchemaType()
This method is provided for implementations to provide
optional type information about the associated event.
|
abstract
boolean
|
isAttribute()
A utility function to check if this event is an Attribute.
|
abstract
boolean
|
isCharacters()
A utility function to check if this event is Characters.
|
abstract
boolean
|
isEndDocument()
A utility function to check if this event is an EndDocument.
|
abstract
boolean
|
isEndElement()
A utility function to check if this event is a EndElement.
|
abstract
boolean
|
isEntityReference()
A utility function to check if this event is an EntityReference.
|
abstract
boolean
|
isNamespace()
A utility function to check if this event is a Namespace.
|
abstract
boolean
|
isProcessingInstruction()
A utility function to check if this event is a ProcessingInstruction.
|
abstract
boolean
|
isStartDocument()
A utility function to check if this event is a StartDocument.
|
abstract
boolean
|
isStartElement()
A utility function to check if this event is a StartElement.
|
abstract
void
|
writeAsEncodedUnicode(Writer writer)
This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.
|
|
Public Methods
public
abstract
Attribute
getAttributeByName
(QName name)
Returns the attribute referred to by this name
Parameters
name
| the qname of the desired name |
Returns
- the attribute corresponding to the name value or null
public
abstract
Iterator
getAttributes
()
Returns an Iterator of non-namespace declared attributes declared on
this START_ELEMENT,
returns an empty iterator if there are no attributes. The
iterator must contain only implementations of the javax.xml.stream.Attribute
interface. Attributes are fundamentally unordered and may not be reported
in any order.
Returns
- a readonly Iterator over Attribute interfaces, or an
empty iterator
public
abstract
QName
getName
()
Get the name of this event
Returns
- the qualified name of this event
public
abstract
NamespaceContext
getNamespaceContext
()
Gets a read-only namespace context. If no context is
available this method will return an empty namespace context.
The NamespaceContext contains information about all namespaces
in scope for this StartElement.
Returns
- the current namespace context
public
abstract
String
getNamespaceURI
(String prefix)
Gets the value that the prefix is bound to in the
context of this element. Returns null if
the prefix is not bound in this context
Parameters
prefix
| the prefix to lookup |
Returns
- the uri bound to the prefix or null
public
abstract
Iterator
getNamespaces
()
Returns an Iterator of namespaces declared on this element.
This Iterator does not contain previously declared namespaces
unless they appear on the current START_ELEMENT.
Therefore this list may contain redeclared namespaces and duplicate namespace
declarations. Use the getNamespaceContext() method to get the
current context of namespace declarations.
The iterator must contain only implementations of the
javax.xml.stream.Namespace interface.
A Namespace isA Attribute. One
can iterate over a list of namespaces as a list of attributes.
However this method returns only the list of namespaces
declared on this START_ELEMENT and does not
include the attributes declared on this START_ELEMENT.
Returns an empty iterator if there are no namespaces.
Returns
- a readonly Iterator over Namespace interfaces, or an
empty iterator