Top Description Methods
javax.xml.stream.events

public Interface StartElement

extends XMLEvent
Known Direct Implementers
com.sun.xml.internal.stream.events.StartElementEvent
Imports
javax.xml.namespace.QName, .NamespaceContext, java.util.Iterator

The StartElement interface provides access to information about start elements. A StartElement is reported for each Start Tag in the document.
Author
Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
Since
1.6
Version
1.0

Method Summary

Modifier and TypeMethod and Description
public Attribute

Returns:

the attribute corresponding to the name value or null
getAttributeByName
(QName
the qname of the desired attribute
name
)

Returns the attribute referred to by the qname.

public Iterator<Attribute>

Returns:

a readonly Iterator over Attribute interfaces, or an empty iterator
getAttributes
()

Returns an Iterator of non-namespace attributes declared on this START_ELEMENT.

public QName

Returns:

the qualified name of this event
getName
()

Get the name of this event

public NamespaceContext

Returns:

the current namespace context
getNamespaceContext
()

Gets a read-only namespace context.

public Iterator<Namespace>

Returns:

a readonly Iterator over Namespace interfaces, or an empty iterator
getNamespaces
()

Returns an Iterator of namespaces declared on this element.

public String

Returns:

the uri bound to the prefix or null
getNamespaceURI
(String
the prefix to lookup
prefix
)

Gets the value that the prefix is bound to in the context of this element.

Inherited from javax.xml.stream.events.XMLEvent:
asCharactersasEndElementasStartElementgetEventTypegetLocationgetSchemaTypeisAttributeisCharactersisEndDocumentisEndElementisEntityReferenceisNamespaceisProcessingInstructionisStartDocumentisStartElementwriteAsEncodedUnicode

Method Detail

getAttributeByNameback to summary
public Attribute getAttributeByName(QName name)

Returns the attribute referred to by the qname.

Parameters
name:QName

the qname of the desired attribute

Returns:Attribute

the attribute corresponding to the name value or null

getAttributesback to summary
public Iterator<Attribute> getAttributes()

Returns an Iterator of non-namespace attributes declared on this START_ELEMENT. Returns an empty iterator if there are no attributes. The iterator must contain only implementations of the Attribute interface. Attributes are fundamentally unordered and may be reported in any order.

Returns:Iterator<Attribute>

a readonly Iterator over Attribute interfaces, or an empty iterator

getNameback to summary
public QName getName()

Get the name of this event

Returns:QName

the qualified name of this event

getNamespaceContextback to summary
public 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:NamespaceContext

the current namespace context

getNamespacesback to summary
public Iterator<Namespace> 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 Namespace interface.

A Namespace is an 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:Iterator<Namespace>

a readonly Iterator over Namespace interfaces, or an empty iterator

getNamespaceURIback to summary
public 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:String

the prefix to lookup

Returns:String

the uri bound to the prefix or null