com.sun.xml.fastinfoset.stax.events
Class StartElementEvent

java.lang.Object
  extended bycom.sun.xml.fastinfoset.stax.events.EventBase
      extended bycom.sun.xml.fastinfoset.stax.events.StartElementEvent
All Implemented Interfaces:
javax.xml.stream.events.StartElement, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants

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


Field Summary
 
Fields inherited from class com.sun.xml.fastinfoset.stax.events.EventBase
_eventType, _location
 
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(QName qname)
           
StartElementEvent(java.lang.String prefix, java.lang.String uri, java.lang.String localpart)
           
 
Method Summary
 void addAttribute(javax.xml.stream.events.Attribute attr)
           
 void addAttributes(java.util.Iterator attrs)
           
 void addNamespace(javax.xml.stream.events.Namespace namespace)
           
 void addNamespaces(java.util.Iterator namespaces)
           
 javax.xml.stream.events.Attribute getAttributeByName(QName qname)
          Returns the attribute referred to by this name
 java.util.Iterator getAttributes()
          Returns an Iterator of non-namespace declared attributes returns an empty iterator if there are no attributes.
 QName getName()
          Get the name of this event
 java.lang.String getNamespace()
           
 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()
           
 java.lang.String nameAsString()
          Return this event as String
 void reset()
           
 void setName(QName qname)
           
 void setNamespaceContext(NamespaceContext context)
           
 java.lang.String toString()
           
 
Methods inherited from class com.sun.xml.fastinfoset.stax.events.EventBase
asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, getSystemId, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, setEventType, setLocation, 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
getAttributeByName
 
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(java.lang.String prefix,
                         java.lang.String uri,
                         java.lang.String localpart)

StartElementEvent

public StartElementEvent(QName qname)
Method Detail

reset

public void reset()

init

protected void init()

getName

public QName getName()
Get the name of this event

Specified by:
getName in interface javax.xml.stream.events.StartElement
Returns:
the qualified name of this event

getAttributes

public java.util.Iterator getAttributes()
Returns an Iterator of non-namespace declared attributes 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()
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 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.

Specified by:
getNamespaces in interface javax.xml.stream.events.StartElement
Returns:
a readonly Iterator over Namespace interfaces, or an empty iterator if there are no namespaces.

getAttributeByName

public javax.xml.stream.events.Attribute getAttributeByName(QName qname)
Returns the attribute referred to by this name

Parameters:
qname - the qname of the desired name
Returns:
the attribute corresponding to the name value or null

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.

Specified by:
getNamespaceContext in interface javax.xml.stream.events.StartElement
Returns:
the current namespace context

setName

public void setName(QName qname)

getNamespace

public java.lang.String getNamespace()

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.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

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

toString

public java.lang.String toString()

nameAsString

public java.lang.String nameAsString()
Return this event as String

Returns:
String Event returned as string.

setNamespaceContext

public void setNamespaceContext(NamespaceContext context)

addAttribute

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

addAttributes

public void addAttributes(java.util.Iterator attrs)

addNamespace

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

addNamespaces

public void addNamespaces(java.util.Iterator namespaces)