Package com.bea.xml.stream.events
Class StartElementEvent
java.lang.Object
com.bea.xml.stream.events.BaseEvent
com.bea.xml.stream.events.NamedEvent
com.bea.xml.stream.events.StartElementEvent
- All Implemented Interfaces:
StartElement
,XMLEvent
,Location
,XMLStreamConstants
-
Field Summary
Fields inherited from interface 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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttribute
(Attribute attribute) void
addNamespace
(Namespace attribute) protected void
doWriteAsEncodedUnicode
(Writer writer) Template method to be implemented by sub-classes.getAttributeByName
(QName name) Returns the attribute referred to by this nameReturns an Iterator of non-namespace declared attributes declared on this START_ELEMENT, returns an empty iterator if there are no attributes.Gets a read-only namespace context.Returns an Iterator of namespaces declared on this element.getNamespaceURI
(String prefix) Gets the value that the prefix is bound to in the context of this element.protected void
init()
void
reset()
void
setAttributes
(List attributes) void
toString()
Methods inherited from class com.bea.xml.stream.events.NamedEvent
getName, nameAsString, setName
Methods inherited from class com.bea.xml.stream.events.BaseEvent
asCharacters, asEndElement, asStartElement, getCharacterOffset, getColumnNumber, getEventType, getLineNumber, getLocation, getLocationURI, getPublicId, getSchemaType, getSourceName, getSystemId, getTypeAsString, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, recycle, setCharacterOffset, setColumnNumber, setEventType, setLineNumber, setLocationURI, writeAsEncodedUnicode
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface javax.xml.stream.events.StartElement
getName
Methods inherited from interface javax.xml.stream.events.XMLEvent
asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, writeAsEncodedUnicode
-
Constructor Details
-
StartElementEvent
public StartElementEvent() -
StartElementEvent
-
StartElementEvent
-
-
Method Details
-
reset
public void reset() -
init
protected void init() -
getAttributes
Description copied from 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. 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.- Specified by:
getAttributes
in interfaceStartElement
- Returns:
- a readonly Iterator over Attribute interfaces, or an empty iterator
-
getNamespaces
Description copied from interface:javax.xml.stream.events.StartElement
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.
- Specified by:
getNamespaces
in interfaceStartElement
- Returns:
- a readonly Iterator over Namespace interfaces, or an empty iterator
-
getAttributeByName
Description copied from interface:javax.xml.stream.events.StartElement
Returns the attribute referred to by this name- Specified by:
getAttributeByName
in interfaceStartElement
- Parameters:
name
- the qname of the desired name- Returns:
- the attribute corresponding to the name value or null
-
setAttributes
-
addAttribute
-
addNamespace
-
getNamespaceURI
Description copied from interface:javax.xml.stream.events.StartElement
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- Specified by:
getNamespaceURI
in interfaceStartElement
- Parameters:
prefix
- the prefix to lookup- Returns:
- the uri bound to the prefix or null
-
setNamespaceContext
-
getNamespaceContext
Description copied from interface:javax.xml.stream.events.StartElement
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.- Specified by:
getNamespaceContext
in interfaceStartElement
- Returns:
- the current namespace context
-
toString
-
doWriteAsEncodedUnicode
Description copied from class:BaseEvent
Template method to be implemented by sub-classes.- Specified by:
doWriteAsEncodedUnicode
in classNamedEvent
- Throws:
IOException
XMLStreamException
-