Woodstox 6.5.1 · com.ctc.wstx.evt.BaseStartElement · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected final QName	mName
protected final BaseNsContext	mNsCtxt

Access	Constructor and Description
protected	BaseStartElement(Location loc, QName name, BaseNsContext nsCtxt)

Method Summary

Modifier and Type	Method and Description
public StartElement	asStartElement() Overrides org.codehaus.stax2.ri.evt.BaseEventImpl.asStartElement. Implements javax.xml.stream.events.XMLEvent.asStartElement. Returns this event as a start element event, may result in a class cast exception if this event is not a start element.
public boolean	equals(Object the reference object with which to compare. o) Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.equals. Declared abstract to force redefinition by sub-classes
public abstract Attribute	getAttributeByName(QName the qname of the desired attribute name) Redeclares javax.xml.stream.events.StartElement.getAttributeByName. Returns the attribute referred to by the qname.
public abstract Iterator<Attribute>	getAttributes() Redeclares javax.xml.stream.events.StartElement.getAttributes. Returns an Iterator of non-namespace attributes declared on this START_ELEMENT.
public int	getEventType() Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.getEventType. Implements javax.xml.stream.events.XMLEvent.getEventType. Returns an integer code for this event.
public final QName	getName() Implements javax.xml.stream.events.StartElement.getName. Get the name of this event
public NamespaceContext	getNamespaceContext() Implements javax.xml.stream.events.StartElement.getNamespaceContext. Gets a read-only namespace context.
public Iterator<Namespace>	getNamespaces() Implements javax.xml.stream.events.StartElement.getNamespaces. Returns an Iterator of namespaces declared on this element.
public String	getNamespaceURI(String the prefix to lookup prefix) Implements javax.xml.stream.events.StartElement.getNamespaceURI. Gets the value that the prefix is bound to in the context of this element.
public int	hashCode() Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.hashCode. Declared abstract to force redefinition by sub-classes
public boolean	isStartElement() Overrides org.codehaus.stax2.ri.evt.BaseEventImpl.isStartElement. Implements javax.xml.stream.events.XMLEvent.isStartElement. A utility function to check if this event is a StartElement.
protected abstract void	outputNsAndAttr(Writer w)
protected abstract void	outputNsAndAttr(XMLStreamWriter w)
public void	writeAsEncodedUnicode(Writer The writer that will output the data w) Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.writeAsEncodedUnicode. Implements javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode. This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.
public void	writeUsing(XMLStreamWriter2 w) Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.writeUsing. Implements org.codehaus.stax2.evt.XMLEvent2.writeUsing.

Inherited from org.codehaus.stax2.ri.evt.BaseEventImpl:: addHash asCharacters asEndElement getLocation getSchemaType isAttribute isCharacters isEndDocument isEndElement isEntityReference isNamespace isProcessingInstruction isStartDocument iteratedEquals stringsWithNullsEqual throwFromIOE toString

mName	back to summary
protected final QName mName

mNsCtxt	back to summary
protected final BaseNsContext mNsCtxt

BaseStartElement	back to summary
protected BaseStartElement(Location loc, QName name, BaseNsContext nsCtxt)

Method Detail

asStartElement back to summary

asStartElement	back to summary
public StartElement asStartElement() Overrides org.codehaus.stax2.ri.evt.BaseEventImpl.asStartElement. Implements javax.xml.stream.events.XMLEvent.asStartElement. Doc from javax.xml.stream.events.XMLEvent.asStartElement. Returns this event as a start element event, may result in a class cast exception if this event is not a start element. Returns:StartElement a `StartElement` event Annotations @Override

public StartElement asStartElement()

Overrides org.codehaus.stax2.ri.evt.BaseEventImpl.asStartElement.

Implements javax.xml.stream.events.XMLEvent.asStartElement.

Doc from javax.xml.stream.events.XMLEvent.asStartElement.

Returns this event as a start element event, may result in a class cast exception if this event is not a start element.

Returns:StartElement

a StartElement event

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object o) Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.equals. Doc from org.codehaus.stax2.ri.evt.BaseEventImpl.equals. Declared abstract to force redefinition by sub-classes Parameters o:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.equals.

Doc from org.codehaus.stax2.ri.evt.BaseEventImpl.equals.

Declared abstract to force redefinition by sub-classes

Parameters

o:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAttributeByName	back to summary
public abstract Attribute getAttributeByName(QName name) Redeclares javax.xml.stream.events.StartElement.getAttributeByName. Doc from javax.xml.stream.events.StartElement.getAttributeByName. 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 Annotations @Override

getAttributeByName

back to summary

public abstract Attribute getAttributeByName(QName name)

Redeclares javax.xml.stream.events.StartElement.getAttributeByName.

Doc from javax.xml.stream.events.StartElement.getAttributeByName.

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

Annotations

@Override

getAttributes back to summary

getAttributes	back to summary
public abstract Iterator<Attribute> getAttributes() Redeclares javax.xml.stream.events.StartElement.getAttributes. Doc from javax.xml.stream.events.StartElement.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 Annotations @Override

public abstract Iterator<Attribute> getAttributes()

Redeclares javax.xml.stream.events.StartElement.getAttributes.

Doc from javax.xml.stream.events.StartElement.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

Annotations

@Override

getEventType	back to summary
public int getEventType() Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.getEventType. Implements javax.xml.stream.events.XMLEvent.getEventType. Doc from javax.xml.stream.events.XMLEvent.getEventType. Returns an integer code for this event. Returns:int the event type Annotations @Override

getEventType

back to summary

public int getEventType()

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.getEventType.

Implements javax.xml.stream.events.XMLEvent.getEventType.

Doc from javax.xml.stream.events.XMLEvent.getEventType.

Returns an integer code for this event.

Returns:int

the event type

Annotations

@Override

getName	back to summary
public final QName getName() Implements javax.xml.stream.events.StartElement.getName. Doc from javax.xml.stream.events.StartElement.getName. Get the name of this event Returns:QName the qualified name of this event Annotations @Override

getName

back to summary

public final QName getName()

Implements javax.xml.stream.events.StartElement.getName.

Doc from javax.xml.stream.events.StartElement.getName.

Get the name of this event

Returns:QName

the qualified name of this event

Annotations

@Override

getNamespaceContext	back to summary
public NamespaceContext getNamespaceContext() Implements javax.xml.stream.events.StartElement.getNamespaceContext. Doc from javax.xml.stream.events.StartElement.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 Annotations @Override

getNamespaceContext

back to summary

public NamespaceContext getNamespaceContext()

Implements javax.xml.stream.events.StartElement.getNamespaceContext.

Doc from javax.xml.stream.events.StartElement.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

Annotations

@Override

getNamespaces back to summary

getNamespaces	back to summary
public Iterator<Namespace> getNamespaces() Implements javax.xml.stream.events.StartElement.getNamespaces. Doc from javax.xml.stream.events.StartElement.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 Annotations @Override

public Iterator<Namespace> getNamespaces()

Implements javax.xml.stream.events.StartElement.getNamespaces.

Doc from javax.xml.stream.events.StartElement.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

Annotations

@Override

getNamespaceURI	back to summary
public String getNamespaceURI(String prefix) Implements javax.xml.stream.events.StartElement.getNamespaceURI. Doc from javax.xml.stream.events.StartElement.getNamespaceURI. 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 Annotations @Override

getNamespaceURI

back to summary

public String getNamespaceURI(String prefix)

Implements javax.xml.stream.events.StartElement.getNamespaceURI.

Doc from javax.xml.stream.events.StartElement.getNamespaceURI.

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

Annotations

@Override

hashCode	back to summary
public int hashCode() Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.hashCode. Doc from org.codehaus.stax2.ri.evt.BaseEventImpl.hashCode. Declared abstract to force redefinition by sub-classes Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object Annotations @Override

hashCode

back to summary

public int hashCode()

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.hashCode.

Doc from org.codehaus.stax2.ri.evt.BaseEventImpl.hashCode.

Declared abstract to force redefinition by sub-classes

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

Annotations

@Override

isStartElement back to summary

isStartElement	back to summary
public boolean isStartElement() Overrides org.codehaus.stax2.ri.evt.BaseEventImpl.isStartElement. Implements javax.xml.stream.events.XMLEvent.isStartElement. Doc from javax.xml.stream.events.XMLEvent.isStartElement. A utility function to check if this event is a StartElement. Returns:boolean true if the event is `StartElement`, false otherwise Annotations @Override

public boolean isStartElement()

Overrides org.codehaus.stax2.ri.evt.BaseEventImpl.isStartElement.

Implements javax.xml.stream.events.XMLEvent.isStartElement.

Doc from javax.xml.stream.events.XMLEvent.isStartElement.

A utility function to check if this event is a StartElement.

Returns:boolean

true if the event is StartElement, false otherwise

Annotations

@Override

outputNsAndAttr	back to summary
protected abstract void outputNsAndAttr(Writer w) throws IOException

outputNsAndAttr	back to summary
protected abstract void outputNsAndAttr(XMLStreamWriter w) throws XMLStreamException

writeAsEncodedUnicode	back to summary
public void writeAsEncodedUnicode(Writer w) throws XMLStreamException Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.writeAsEncodedUnicode. Implements javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode. Doc from javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode. This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters. No indentation or whitespace should be outputted. Any user defined event type SHALL have this method called when being written to on an output stream. Built in Event types MUST implement this method, but implementations MAY choose not call these methods for optimizations reasons when writing out built in Events to an output stream. The output generated MUST be equivalent in terms of the infoset expressed. Parameters w:Writer The writer that will output the data Annotations @Override Exceptions XMLStreamException: if there is a fatal error writing the event

writeAsEncodedUnicode

back to summary

public void writeAsEncodedUnicode(Writer w) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.writeAsEncodedUnicode.

Implements javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode.

Doc from javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode.

This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters. No indentation or whitespace should be outputted. Any user defined event type SHALL have this method called when being written to on an output stream. Built in Event types MUST implement this method, but implementations MAY choose not call these methods for optimizations reasons when writing out built in Events to an output stream. The output generated MUST be equivalent in terms of the infoset expressed.

Parameters

w:Writer: The writer that will output the data

Annotations

@Override

Exceptions

XMLStreamException:: if there is a fatal error writing the event

writeUsing	back to summary
public void writeUsing(XMLStreamWriter2 w) throws XMLStreamException Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.writeUsing. Implements org.codehaus.stax2.evt.XMLEvent2.writeUsing. Annotations @Override

writeUsing

back to summary

public void writeUsing(XMLStreamWriter2 w) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.writeUsing.

Implements org.codehaus.stax2.evt.XMLEvent2.writeUsing.

Annotations

@Override

pack-priv abstract Class BaseStartElement

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail