This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.xml.stream.events
interface StartElement
- All Superinterfaces:
- XMLEvent, XMLStreamConstants
-
Most common way to construct:
-
XMLEvent event = …;
StartElement e = event.asStartElement();
Based on 21 examples
public interface StartElement
extends XMLEvent
The StartElement interface provides access to information about
start elements. A StartElement is reported for each Start Tag
in the document.
Fields inherited from class javax.xml.stream.XMLStreamConstants |
ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT |
Method Summary |
Attribute |
Returns the attribute referred to by this name
|
Iterator |
Returns an Iterator of non-namespace declared attributes declared on
this START_ELEMENT,
returns an empty iterator if there are no attributes.
|
QName |
Get the name of this event
|
NamespaceContext |
Gets a read-only namespace context.
|
Iterator |
Returns an Iterator of namespaces declared on this element.
|
String |
Gets the value that the prefix is bound to in the
context of this element.
|
Methods inherited from class javax.xml.stream.events.XMLEvent |
asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, writeAsEncodedUnicode |
getAttributeByName
public 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
getAttributes
public 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
getName
public QName getName()
-
Get the name of this event
- Returns:
- the qualified name of this event
getNamespaceContext
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:
- the current namespace context
getNamespaces
public 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
getNamespaceURI
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
- the prefix to lookup
- Returns:
- the uri bound to the prefix or null
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.