com.bea.xml.stream.events
Class StartElementEvent

java.lang.Object
  extended bycom.bea.xml.stream.events.BaseEvent
      extended bycom.bea.xml.stream.events.NamedEvent
          extended bycom.bea.xml.stream.events.StartElementEvent
All Implemented Interfaces:
javax.xml.stream.Location, javax.xml.stream.events.StartElement, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants

public class StartElementEvent
extends NamedEvent
implements javax.xml.stream.events.StartElement


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
StartElementEvent()
           
StartElementEvent(javax.xml.namespace.QName name)
           
StartElementEvent(javax.xml.stream.events.StartElement element)
           
 
Method Summary
 void addAttribute(javax.xml.stream.events.Attribute attribute)
           
 void addNamespace(javax.xml.stream.events.Namespace attribute)
           
 javax.xml.stream.events.Attribute getAttributeByName(javax.xml.namespace.QName name)
          Returns the attribute referred to by this name
 java.util.Iterator getAttributes()
          Returns an Iterator of non-namespace declared attributes declared on this START_ELEMENT, returns an empty iterator if there are no attributes.
 javax.xml.namespace.NamespaceContext getNamespaceContext()
          Gets a read-only namespace context.
 java.util.Iterator getNamespaces()
          Returns an Iterator of namespaces declared on this element.
 java.lang.String getNamespaceURI(java.lang.String prefix)
          Gets the value that the prefix is bound to in the context of this element.
protected  void init()
           
 void reset()
           
 void setAttributes(java.util.List attributes)
           
 void setNamespaceContext(javax.xml.namespace.NamespaceContext c)
           
 java.lang.String 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 Detail

StartElementEvent

public StartElementEvent()

StartElementEvent

public StartElementEvent(javax.xml.namespace.QName name)

StartElementEvent

public StartElementEvent(javax.xml.stream.events.StartElement element)
Method Detail

reset

public void reset()

init

protected void init()

getAttributes

public java.util.Iterator 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 interface javax.xml.stream.events.StartElement
Returns:
a readonly Iterator over Attribute interfaces, or an empty iterator

getNamespaces

public java.util.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 interface javax.xml.stream.events.StartElement
Returns:
a readonly Iterator over Namespace interfaces, or an empty iterator

getAttributeByName

public javax.xml.stream.events.Attribute getAttributeByName(javax.xml.namespace.QName name)
Description copied from interface: javax.xml.stream.events.StartElement
Returns the attribute referred to by this name

Specified by:
getAttributeByName in interface javax.xml.stream.events.StartElement
Parameters:
name - the qname of the desired name
Returns:
the attribute corresponding to the name value or null

setAttributes

public void setAttributes(java.util.List attributes)

addAttribute

public void addAttribute(javax.xml.stream.events.Attribute attribute)

addNamespace

public void addNamespace(javax.xml.stream.events.Namespace attribute)

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.String prefix)
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 interface javax.xml.stream.events.StartElement
Parameters:
prefix - the prefix to lookup
Returns:
the uri bound to the prefix or null

setNamespaceContext

public void setNamespaceContext(javax.xml.namespace.NamespaceContext c)

getNamespaceContext

public javax.xml.namespace.NamespaceContext 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 interface javax.xml.stream.events.StartElement
Returns:
the current namespace context

toString

public java.lang.String toString()