oracle.security.xmlsec.util

Class NodeReaderForStAX

java.lang.Object

oracle.security.xmlsec.util.NodeReader

oracle.security.xmlsec.util.NodeReaderForStAX

public class NodeReaderForStAX
extends NodeReader

Since:

release specific (what release of product did this appear in)

Version:

$Header: ldap/java/src/oracle/security/xmlsec/util/NodeReaderForStAX.java /main/2 2008/12/17 15:42:25 pdatta Exp $

Nested Class Summary

Nested classes/interfaces inherited from class oracle.security.xmlsec.util.NodeReader

NodeReader.NodeListener

Field Summary

Fields inherited from class oracle.security.xmlsec.util.NodeReader

CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, PROCESSING_INSTRUCTION, START_DOCUMENT, START_ELEMENT

Constructor Summary

Constructors

Constructor and Description
NodeReaderForStAX(java.io.InputStream is, java.lang.String systemId)
NodeReaderForStAX(javax.xml.transform.Source is)
NodeReaderForStAX(javax.xml.stream.XMLStreamReader streamReader)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Iterator	getAttributes() Returns all the namespaces and attributes on this START_ELEMENT.
int	getEventType() Returns an integer code that indicates the type of the event the cursor is pointing to START_ELEMENT END_ELEMENT PROCESSING_INSTRUCTION CHARACTERS COMMENT START_DOCUMENT END_DOCUMENT
java.lang.String	getLocalName() Returns the (local) name of the current event.
java.lang.String	getNamespaceURI() If the current event is a START_ELEMENT or END_ELEMENT this method returns the URI of the prefix or the default namespace
org.w3c.dom.Node	getNode() Returns the current node.
java.lang.String	getPIData() Get the data section of a processing instruction
java.lang.String	getPITarget() Get the target of a processing instruction
java.lang.String	getPrefix() Returns the prefix of the current event or null if the event does not have a prefix
char[]	getText() Returns the current value of the parse event as a character array, this returns the string value of a CHARACTERS event, returns the value of a COMMENT,
int	getTextLength()
int	getTextStart()
boolean	hasNext() Returns true if there are more parsing events and false if there are no more events.
boolean	isElementIncluded() For special case when some of an element's attributes are in the node set but the element itself is not
int	next() Get next parsing event.

Methods inherited from class oracle.security.xmlsec.util.NodeReader

addListener, fireConsumeNode, getAncestorXmlAttributes, getNamespaces, getNamespacesForMissingAncestors, getSortedAttributes, isElementAnOrphan, isElementInheritingNamespaces, isUnnecessaryEmptyDefaultNsRequired, removeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NodeReaderForStAX

public NodeReaderForStAX(java.io.InputStream is,
                 java.lang.String systemId)
                  throws NodeReaderException

Throws:

NodeReaderException

NodeReaderForStAX

public NodeReaderForStAX(javax.xml.transform.Source is)
                  throws NodeReaderException

Throws:

NodeReaderException

NodeReaderForStAX

public NodeReaderForStAX(javax.xml.stream.XMLStreamReader streamReader)

Method Detail

hasNext

public final boolean hasNext()
                      throws NodeReaderException

Description copied from class: NodeReader

Returns true if there are more parsing events and false if there are no more events.

Specified by:

hasNext in class NodeReader

Returns:

Throws:

NodeReaderException

next

public final int next()
               throws NodeReaderException

Description copied from class: NodeReader

Get next parsing event. one of

• START_ELEMENT
• END_ELEMENT
• PROCESSING_INSTRUCTION
• CHARACTERS
• COMMENT
• START_DOCUMENT
• END_DOCUMENT

Specified by:

next in class NodeReader

Returns:

Throws:

NodeReaderException

getEventType

public final int getEventType()

Description copied from class: NodeReader

Returns an integer code that indicates the type of the event the cursor is pointing to

• START_ELEMENT
• END_ELEMENT
• PROCESSING_INSTRUCTION
• CHARACTERS
• COMMENT
• START_DOCUMENT
• END_DOCUMENT

Specified by:

getEventType in class NodeReader

Returns:

getLocalName

public final java.lang.String getLocalName()

Description copied from class: NodeReader

Returns the (local) name of the current event.

Specified by:

getLocalName in class NodeReader

getNamespaceURI

public final java.lang.String getNamespaceURI()

Description copied from class: NodeReader

If the current event is a START_ELEMENT or END_ELEMENT this method returns the URI of the prefix or the default namespace

Specified by:

getNamespaceURI in class NodeReader

getPrefix

public final java.lang.String getPrefix()

Description copied from class: NodeReader

Returns the prefix of the current event or null if the event does not have a prefix

Specified by:

getPrefix in class NodeReader

getText

public final char[] getText()

Description copied from class: NodeReader

Returns the current value of the parse event as a character array, this returns the string value of a CHARACTERS event, returns the value of a COMMENT,

Specified by:

getText in class NodeReader

Returns:

getTextStart

public final int getTextStart()

Specified by:

getTextStart in class NodeReader

getTextLength

public final int getTextLength()

Specified by:

getTextLength in class NodeReader

getPIData

public final java.lang.String getPIData()

Description copied from class: NodeReader

Get the data section of a processing instruction

Specified by:

getPIData in class NodeReader

getPITarget

public final java.lang.String getPITarget()

Description copied from class: NodeReader

Get the target of a processing instruction

Specified by:

getPITarget in class NodeReader

isElementIncluded

public final boolean isElementIncluded()

Description copied from class: NodeReader

For special case when some of an element's attributes are in the node set but the element itself is not

Overrides:

isElementIncluded in class NodeReader

getNode

public final org.w3c.dom.Node getNode()

Description copied from class: NodeReader

Returns the current node. It is ok for this method to return null, it will do that for a non DOM implementation

Overrides:

getNode in class NodeReader

getAttributes

public final java.util.Iterator getAttributes()

Description copied from class: NodeReader

Returns all the namespaces and attributes on this START_ELEMENT.

All NodeReaders must implement this. Additionally a node reader may implement the NodeReader.getNamespaces() and NodeReader.getSortedAttributes() methods to return the namespaces and attributes separately.

Specified by:

getAttributes in class NodeReader