Woodstox 6.5.1 · com.ctc.wstx.sr.InputElementStack · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv static final int	ID_ATTR_NONE
protected final AttributeCollector	mAttrCollector
protected final ReaderConfig	mConfig
protected Element	mCurrElement Currently open element, if any; null outside root element.
protected int	mDepth
protected Element	mFreeElement
protected int	mIdAttrIndex Index of the attribute with type of ID, if known (most likely due to Xml:id support); -1 if not available, or no ID attribute for current element.
protected String	mLastLocalName
protected QName	mLastName
protected BaseNsContext	mLastNsContext Last potentially shareable NamespaceContext created by this stack.
protected String	mLastNsURI
protected String	mLastPrefix
protected boolean	mMayHaveNsDefaults
protected final StringVector	mNamespaces Vector that contains all currently active namespaces; one String for prefix, another for matching URI.
protected final boolean	mNsAware
protected NsDefaultProvider	mNsDefaultProvider Object that will need to be consulted about namespace bindings, since it has some knowledge about default namespace declarations (has default attribute value expansion).
protected InputProblemReporter	mReporter
protected long	mTotalElements
protected XMLValidator	mValidator Optional validator object that will get called if set, and that can validate xml content.

Access	Constructor and Description
protected	InputElementStack(ReaderConfig cfg, boolean nsAware)

Method Summary

Modifier and Type	Method and Description
public int	addDefaultAttribute(String localName, String uri, String prefix, String value) Implements org.codehaus.stax2.validation.ValidationContext.addDefaultAttribute. Method called by actual validator instances when attributes with default values have no explicit values for the element; if so, default value needs to be added as if it was parsed from the element.
public void	addNsBinding(String prefix, String uri) Callback method called by the namespace default provider.
protected XMLValidator	addValidator(XMLValidator vld)
protected void	connectReporter(InputProblemReporter rep)
public BaseNsContext	createNonTransientNsContext(Location loc) Method called to construct a non-transient NamespaceContext instance; generally needed when creating events to return from event-based iterators.
public final int	findAttributeIndex(String nsURI, String localName) Implements org.codehaus.stax2.AttributeInfo.findAttributeIndex, org.codehaus.stax2.validation.ValidationContext.findAttributeIndex.
public final AttributeCollector	getAttrCollector() Method called by `BasicStreamReader`, to retrieve the attribute collector it needs for some direct access.
public final int	getAttributeCount() Implements org.codehaus.stax2.AttributeInfo.getAttributeCount, org.codehaus.stax2.validation.ValidationContext.getAttributeCount. This method returns number of attributes accessible from within currently active start element.
public String	getAttributeLocalName(int index) Implements org.codehaus.stax2.validation.ValidationContext.getAttributeLocalName.
public String	getAttributeNamespace(int index) Implements org.codehaus.stax2.validation.ValidationContext.getAttributeNamespace.
public String	getAttributePrefix(int index) Implements org.codehaus.stax2.validation.ValidationContext.getAttributePrefix.
public final String	Returns: Schema (DTD, RNG, W3C Schema) based type of the attribute in specified index getAttributeType(int index) Implements org.codehaus.stax2.validation.ValidationContext.getAttributeType.
public String	getAttributeValue(int index) Implements org.codehaus.stax2.validation.ValidationContext.getAttributeValue.
public String	getAttributeValue(String nsURI, String localName) Implements org.codehaus.stax2.validation.ValidationContext.getAttributeValue.
public String	getBaseUri() Implements org.codehaus.stax2.validation.ValidationContext.getBaseUri.
public final QName	getCurrentElementName() Implements org.codehaus.stax2.validation.ValidationContext.getCurrentElementName. Method that can be used to access name information of the innermost (top) element in the element stack.
public final int	Returns: Number of active prefix/namespace mappings for current scope, NOT including mappings from enclosing elements. getCurrentNsCount()
public final String	getDefaultNsURI()
public final int	Returns: Number of open elements in the stack; 0 when parser is in prolog/epilog, 1 inside root element and so on. getDepth()
public final int	getIdAttributeIndex() Implements org.codehaus.stax2.AttributeInfo.getIdAttributeIndex. Default implementation just indicates it does not know of such attributes; this because that requires DTD information that only some implementations have.
public final String	getLocalName()
public final String	getLocalNsPrefix(int index)
public final String	getLocalNsURI(int index)
public final String	getNamespaceURI(String prefix to look up prefix) Implements javax.xml.namespace.NamespaceContext.getNamespaceURI, org.codehaus.stax2.validation.ValidationContext.getNamespaceURI. Get Namespace URI bound to a prefix in the current scope.
public final int	getNotationAttributeIndex() Implements org.codehaus.stax2.AttributeInfo.getNotationAttributeIndex. Default implementation just indicates it does not know of such attributes; this because that requires DTD information that only some implementations have.
public final String	getNsURI()
public final String	getPrefix(String URI of Namespace to lookup nsURI) Implements javax.xml.namespace.NamespaceContext.getPrefix. Get prefix bound to Namespace URI in the current scope.
public final String	getPrefix()
public final Iterator<String>	getPrefixes(String URI of Namespace to lookup nsURI) Implements javax.xml.namespace.NamespaceContext.getPrefixes. Get all prefixes bound to a Namespace URI in the current scope.
public final String	getTopElementDesc()
public final int	Returns: Number of active prefix/namespace mappings for current scope, including mappings from enclosing elements. getTotalNsCount()
public Location	getValidationLocation() Implements org.codehaus.stax2.validation.ValidationContext.getValidationLocation. Method that will return the location that best represents current location within document to be validated, if such information is available.
public final String	getXmlVersion() Implements org.codehaus.stax2.validation.ValidationContext.getXmlVersion. Method that validator can call to figure out which xml version document being validated declared (if none, "1.0" is assumed as per xml specifications 1.0 and 1.1).
public final boolean	isEmpty()
public final boolean	isNamespaceAware()
public boolean	isNotationDeclared(String name) Implements org.codehaus.stax2.validation.ValidationContext.isNotationDeclared.
public boolean	isPrefixLocallyDeclared(String internedPrefix)
public boolean	isUnparsedEntityDeclared(String name) Implements org.codehaus.stax2.validation.ValidationContext.isUnparsedEntityDeclared.
public final boolean	matches(String prefix, String localName)
public final boolean	Returns: True if stack has more elements; false if not (that is, root element closed) pop() Method called by the stream reader to remove the topmost (start) element from the stack; called when an end element is encountered during parsing.
public final void	push(String prefix, String localName) Method called by the stream reader to add new (start) element into the stack in namespace-aware mode; called when a start element is encountered during parsing, but only in ns-aware mode.
protected boolean	reallyValidating() This is a method called by the reader to ensure that we have at least one 'real' validator.
public void	reportProblem(XMLValidationProblem problem) Implements org.codehaus.stax2.validation.ValidationContext.reportProblem. Method called by the validator, upon encountering a validation problem.
public int	Returns: Text content validation state that should be effective for the fully resolved element context resolveAndValidateElement() Method called to resolve element and attribute namespaces (in namespace-aware mode), and do optional validation using pluggable validator object.
protected void	setAutomaticDTDValidator(XMLValidator validator, NsDefaultProvider nsDefs) Method called to connect the automatically handled DTD validator (one detected from DOCTYPE, loaded and completely handled by the stream reader without application calling validation methods).
public XMLValidator	stopValidatingAgainst(XMLValidationSchema schema)
public XMLValidator	stopValidatingAgainst(XMLValidator validator)
private void	throwIllegalIndex(int index, int localCount)
public XMLValidator	validateAgainst(XMLValidationSchema schema)
public int	Returns: Validation state that should be effective for the parent element state validateEndElement() Method called after parsing (but before returning) end element, to allow for pluggable validators to verify correctness of the content model for the closing element.
public final void	validateText(TextBuffer tb, boolean lastTextSegment)
public final void	validateText(String contents, boolean lastTextSegment)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

ID_ATTR_NONE	back to summary
pack-priv static final int ID_ATTR_NONE

mAttrCollector	back to summary
protected final AttributeCollector mAttrCollector

mConfig	back to summary
protected final ReaderConfig mConfig

mCurrElement	back to summary
protected Element mCurrElement Currently open element, if any; null outside root element.

mDepth	back to summary
protected int mDepth

mFreeElement	back to summary
protected Element mFreeElement

mIdAttrIndex	back to summary
protected int mIdAttrIndex Index of the attribute with type of ID, if known (most likely due to Xml:id support); -1 if not available, or no ID attribute for current element.

mLastLocalName	back to summary
protected String mLastLocalName

mLastName	back to summary
protected QName mLastName

mLastNsContext	back to summary
protected BaseNsContext mLastNsContext Last potentially shareable NamespaceContext created by this stack. This reference is cleared each time bindings change (either due to a start element with new bindings, or due to the matching end element that closes scope of such binding(s)).

mLastNsURI	back to summary
protected String mLastNsURI

mLastPrefix	back to summary
protected String mLastPrefix

mMayHaveNsDefaults	back to summary
protected boolean mMayHaveNsDefaults

mNamespaces	back to summary
protected final StringVector mNamespaces Vector that contains all currently active namespaces; one String for prefix, another for matching URI. Does also include default name spaces (at most one per level).

mNsAware	back to summary
protected final boolean mNsAware

mNsDefaultProvider	back to summary
protected NsDefaultProvider mNsDefaultProvider Object that will need to be consulted about namespace bindings, since it has some knowledge about default namespace declarations (has default attribute value expansion).

mReporter	back to summary
protected InputProblemReporter mReporter

mTotalElements	back to summary
protected long mTotalElements

mValidator	back to summary
protected XMLValidator mValidator Optional validator object that will get called if set, and that can validate xml content. Note that it is possible that this is set to a proxy object that calls multiple validators in sequence.

InputElementStack	back to summary
protected InputElementStack(ReaderConfig cfg, boolean nsAware)

Method Detail

addDefaultAttribute	back to summary
public int addDefaultAttribute(String localName, String uri, String prefix, String value) throws XMLStreamException Implements org.codehaus.stax2.validation.ValidationContext.addDefaultAttribute. Method called by actual validator instances when attributes with default values have no explicit values for the element; if so, default value needs to be added as if it was parsed from the element. Returns:int Doc from org.codehaus.stax2.validation.ValidationContext.addDefaultAttribute. Index of the newly added attribute, if operation was succesful; -1 if not. Annotations @Override

addDefaultAttribute

back to summary

public int addDefaultAttribute(String localName, String uri, String prefix, String value) throws XMLStreamException

Implements org.codehaus.stax2.validation.ValidationContext.addDefaultAttribute.

Method called by actual validator instances when attributes with default values have no explicit values for the element; if so, default value needs to be added as if it was parsed from the element.

Returns:int

Doc from org.codehaus.stax2.validation.ValidationContext.addDefaultAttribute.

Index of the newly added attribute, if operation was succesful; -1 if not.

Annotations

@Override

addNsBinding	back to summary
public void addNsBinding(String prefix, String uri) Callback method called by the namespace default provider. At this point we can trust it to only call this method with somewhat valid arguments (no dups etc).

addValidator	back to summary
protected XMLValidator addValidator(XMLValidator vld)

connectReporter	back to summary
protected void connectReporter(InputProblemReporter rep)

createNonTransientNsContext	back to summary
public BaseNsContext createNonTransientNsContext(Location loc) Method called to construct a non-transient NamespaceContext instance; generally needed when creating events to return from event-based iterators.

findAttributeIndex	back to summary
public final int findAttributeIndex(String nsURI, String localName) Implements org.codehaus.stax2.AttributeInfo.findAttributeIndex, org.codehaus.stax2.validation.ValidationContext.findAttributeIndex. Returns:int Doc from org.codehaus.stax2.AttributeInfo.findAttributeIndex. Index of the specified attribute, if the current element has such an attribute (explicit, or one created via default value expansion); -1 if not. Annotations @Override

findAttributeIndex

back to summary

public final int findAttributeIndex(String nsURI, String localName)

Implements org.codehaus.stax2.AttributeInfo.findAttributeIndex, org.codehaus.stax2.validation.ValidationContext.findAttributeIndex.

Returns:int

Doc from org.codehaus.stax2.AttributeInfo.findAttributeIndex.

Index of the specified attribute, if the current element has such an attribute (explicit, or one created via default value expansion); -1 if not.

Annotations

@Override

getAttrCollector	back to summary
public final AttributeCollector getAttrCollector() Method called by `BasicStreamReader`, to retrieve the attribute collector it needs for some direct access.

getAttributeCount back to summary

getAttributeCount	back to summary
public final int getAttributeCount() Implements org.codehaus.stax2.AttributeInfo.getAttributeCount, org.codehaus.stax2.validation.ValidationContext.getAttributeCount. Doc from org.codehaus.stax2.validation.ValidationContext.getAttributeCount. This method returns number of attributes accessible from within currently active start element. Note this method is only guaranteed to be callable during execution of `XMLValidator` methods `XMLValidator#validateElementStart`, `XMLValidator#validateAttribute` and `XMLValidator#validateElementAndAttributes`. At other times implementations may choose to allow it to be called (for example, with information regarding last start element processed), to throw a `IllegalArgumentException`, or to return 0 to indicate no attribute information is available. Also note that whether defaulted attributes (attributes for which values are only available via attribute defaulting) are accessible depends on exact time when this method is called, and in general can not be assumed to function reliably. Returns:int Doc from org.codehaus.stax2.AttributeInfo.getAttributeCount. Number of all attributes accessible (including ones created from the default values, if any) using this Object. Annotations @Override

public final int getAttributeCount()

Implements org.codehaus.stax2.AttributeInfo.getAttributeCount, org.codehaus.stax2.validation.ValidationContext.getAttributeCount.

Doc from org.codehaus.stax2.validation.ValidationContext.getAttributeCount.

This method returns number of attributes accessible from within currently active start element.

Note

this method is only guaranteed to be callable during execution of XMLValidator methods XMLValidator#validateElementStart, XMLValidator#validateAttribute and XMLValidator#validateElementAndAttributes. At other times implementations may choose to allow it to be called (for example, with information regarding last start element processed), to throw a IllegalArgumentException, or to return 0 to indicate no attribute information is available.

Also note that whether defaulted attributes (attributes for which values are only available via attribute defaulting) are accessible depends on exact time when this method is called, and in general can not be assumed to function reliably.

Returns:int

Doc from org.codehaus.stax2.AttributeInfo.getAttributeCount.

Number of all attributes accessible (including ones created from the default values, if any) using this Object.

Annotations

@Override

getAttributeLocalName	back to summary
public String getAttributeLocalName(int index) Implements org.codehaus.stax2.validation.ValidationContext.getAttributeLocalName. Annotations @Override

getAttributeLocalName

back to summary

public String getAttributeLocalName(int index)

Implements org.codehaus.stax2.validation.ValidationContext.getAttributeLocalName.

Annotations

@Override

getAttributeNamespace	back to summary
public String getAttributeNamespace(int index) Implements org.codehaus.stax2.validation.ValidationContext.getAttributeNamespace. Annotations @Override

getAttributeNamespace

back to summary

public String getAttributeNamespace(int index)

Implements org.codehaus.stax2.validation.ValidationContext.getAttributeNamespace.

Annotations

@Override

getAttributePrefix	back to summary
public String getAttributePrefix(int index) Implements org.codehaus.stax2.validation.ValidationContext.getAttributePrefix. Annotations @Override

getAttributePrefix

back to summary

public String getAttributePrefix(int index)

Implements org.codehaus.stax2.validation.ValidationContext.getAttributePrefix.

Annotations

@Override

getAttributeType	back to summary
public final String getAttributeType(int index) Implements org.codehaus.stax2.validation.ValidationContext.getAttributeType. Returns:String Schema (DTD, RNG, W3C Schema) based type of the attribute in specified index Annotations @Override

getAttributeType

back to summary

public final String getAttributeType(int index)

Implements org.codehaus.stax2.validation.ValidationContext.getAttributeType.

Returns:String

Schema (DTD, RNG, W3C Schema) based type of the attribute in specified index

Annotations

@Override

getAttributeValue	back to summary
public String getAttributeValue(int index) Implements org.codehaus.stax2.validation.ValidationContext.getAttributeValue. Annotations @Override

getAttributeValue

back to summary

public String getAttributeValue(int index)

Implements org.codehaus.stax2.validation.ValidationContext.getAttributeValue.

Annotations

@Override

getAttributeValue	back to summary
public String getAttributeValue(String nsURI, String localName) Implements org.codehaus.stax2.validation.ValidationContext.getAttributeValue. Annotations @Override

getAttributeValue

back to summary

public String getAttributeValue(String nsURI, String localName)

Implements org.codehaus.stax2.validation.ValidationContext.getAttributeValue.

Annotations

@Override

getBaseUri	back to summary
public String getBaseUri() Implements org.codehaus.stax2.validation.ValidationContext.getBaseUri. Returns:String Doc from org.codehaus.stax2.validation.ValidationContext.getBaseUri. Base URI active in the current location of the document being validated, if known; null to indicate no base URI known. Annotations @Override

getBaseUri

back to summary

public String getBaseUri()

Implements org.codehaus.stax2.validation.ValidationContext.getBaseUri.

Returns:String

Doc from org.codehaus.stax2.validation.ValidationContext.getBaseUri.

Base URI active in the current location of the document being validated, if known; null to indicate no base URI known.

Annotations

@Override

getCurrentElementName	back to summary
public final QName getCurrentElementName() Implements org.codehaus.stax2.validation.ValidationContext.getCurrentElementName. Doc from org.codehaus.stax2.validation.ValidationContext.getCurrentElementName. Method that can be used to access name information of the innermost (top) element in the element stack. Returns:QName Name of the element at the top of the current element stack, if any. During validation calls it refers to the element being processed (start or end tag), or its parent (when processing text nodes), or null (in document prolog and epilog). Annotations @Override

getCurrentElementName

back to summary

public final QName getCurrentElementName()

Implements org.codehaus.stax2.validation.ValidationContext.getCurrentElementName.

Doc from org.codehaus.stax2.validation.ValidationContext.getCurrentElementName.

Method that can be used to access name information of the innermost (top) element in the element stack.

Returns:QName

Name of the element at the top of the current element stack, if any. During validation calls it refers to the element being processed (start or end tag), or its parent (when processing text nodes), or null (in document prolog and epilog).

Annotations

@Override

getCurrentNsCount	back to summary
public final int getCurrentNsCount() Returns:int Number of active prefix/namespace mappings for current scope, NOT including mappings from enclosing elements.

getDefaultNsURI	back to summary
public final String getDefaultNsURI()

getDepth	back to summary
public final int getDepth() Returns:int Number of open elements in the stack; 0 when parser is in prolog/epilog, 1 inside root element and so on.

getIdAttributeIndex	back to summary
public final int getIdAttributeIndex() Implements org.codehaus.stax2.AttributeInfo.getIdAttributeIndex. Default implementation just indicates it does not know of such attributes; this because that requires DTD information that only some implementations have. Returns:int Doc from org.codehaus.stax2.AttributeInfo.getIdAttributeIndex. Index of the ID attribute of current element, if the current element has such an attribute defined; -1 if not. Annotations @Override

getIdAttributeIndex

back to summary

public final int getIdAttributeIndex()

Implements org.codehaus.stax2.AttributeInfo.getIdAttributeIndex.

Default implementation just indicates it does not know of such attributes; this because that requires DTD information that only some implementations have.

Returns:int

Doc from org.codehaus.stax2.AttributeInfo.getIdAttributeIndex.

Index of the ID attribute of current element, if the current element has such an attribute defined; -1 if not.

Annotations

@Override

getLocalName	back to summary
public final String getLocalName()

getLocalNsPrefix	back to summary
public final String getLocalNsPrefix(int index)

getLocalNsURI	back to summary
public final String getLocalNsURI(int index)

getNamespaceURI back to summary

public final String getNamespaceURI(String prefix)

Implements javax.xml.namespace.NamespaceContext.getNamespaceURI, org.codehaus.stax2.validation.ValidationContext.getNamespaceURI.

Doc from javax.xml.namespace.NamespaceContext.getNamespaceURI.

Get Namespace URI bound to a prefix in the current scope.

When requesting a Namespace URI by prefix, the following table describes the returned Namespace URI value for all possible prefix values:

Return value for specified prefixes
prefix parameter	Namespace URI return value
`DEFAULT_NS_PREFIX` ("")	default Namespace URI in the current scope or `XMLConstants.NULL_NS_URI("")` when there is no default Namespace URI in the current scope
bound prefix	Namespace URI bound to prefix in current scope
unbound prefix	`XMLConstants.NULL_NS_URI("")`
`XMLConstants.XML_NS_PREFIX` ("xml")	`XMLConstants.XML_NS_URI` ("http://www.w3.org/XML/1998/namespace")
`XMLConstants.XMLNS_ATTRIBUTE` ("xmlns")	`XMLConstants.XMLNS_ATTRIBUTE_NS_URI` ("http://www.w3.org/2000/xmlns/")
`null`	`IllegalArgumentException` is thrown

Parameters

prefix:String: prefix to look up

Returns:String

Namespace URI bound to prefix in the current scope

Annotations

@Override

getNotationAttributeIndex	back to summary
public final int getNotationAttributeIndex() Implements org.codehaus.stax2.AttributeInfo.getNotationAttributeIndex. Default implementation just indicates it does not know of such attributes; this because that requires DTD information that only some implementations have. Returns:int Doc from org.codehaus.stax2.AttributeInfo.getNotationAttributeIndex. Index of the NOTATION attribute of current element, if the current element has such an attribute defined; -1 if not. Annotations @Override

getNotationAttributeIndex

back to summary

public final int getNotationAttributeIndex()

Implements org.codehaus.stax2.AttributeInfo.getNotationAttributeIndex.

Default implementation just indicates it does not know of such attributes; this because that requires DTD information that only some implementations have.

Returns:int

Doc from org.codehaus.stax2.AttributeInfo.getNotationAttributeIndex.

Index of the NOTATION attribute of current element, if the current element has such an attribute defined; -1 if not.

Annotations

@Override

getNsURI	back to summary
public final String getNsURI()

getPrefix back to summary

public final String getPrefix(String nsURI)

Implements javax.xml.namespace.NamespaceContext.getPrefix.

Doc from javax.xml.namespace.NamespaceContext.getPrefix.

Get prefix bound to Namespace URI in the current scope.

To get all prefixes bound to a Namespace URI in the current scope, use getPrefixes(String namespaceURI).

When requesting a prefix by Namespace URI, the following table describes the returned prefix value for all Namespace URI values:

Return value for specified Namespace URIs
Namespace URI parameter	prefix value returned
`<default Namespace URI>`	`XMLConstants.DEFAULT_NS_PREFIX` ("")
bound Namespace URI	prefix bound to Namespace URI in the current scope, if multiple prefixes are bound to the Namespace URI in the current scope, a single arbitrary prefix, whose choice is implementation dependent, is returned
unbound Namespace URI	`null`
`XMLConstants.XML_NS_URI` ("http://www.w3.org/XML/1998/namespace")	`XMLConstants.XML_NS_PREFIX` ("xml")
`XMLConstants.XMLNS_ATTRIBUTE_NS_URI` ("http://www.w3.org/2000/xmlns/")	`XMLConstants.XMLNS_ATTRIBUTE` ("xmlns")
`null`	`IllegalArgumentException` is thrown

Parameters

nsURI:String: URI of Namespace to lookup

Returns:String

prefix bound to Namespace URI in current context

Annotations

@Override

getPrefix	back to summary
public final String getPrefix()

getPrefixes back to summary

public final Iterator<String> getPrefixes(String nsURI)

Implements javax.xml.namespace.NamespaceContext.getPrefixes.

Doc from javax.xml.namespace.NamespaceContext.getPrefixes.

Get all prefixes bound to a Namespace URI in the current scope.

An Iterator over String elements is returned in an arbitrary, implementation dependent, order.

The Iterator is not modifiable. e.g. the remove() method will throw UnsupportedOperationException.

When requesting prefixes by Namespace URI, the following table describes the returned prefixes value for all Namespace URI values:

Return value for specified Namespace URIs
Namespace URI parameter	prefixes value returned
bound Namespace URI, including the `<default Namespace URI>`	`Iterator` over prefixes bound to Namespace URI in the current scope in an arbitrary, implementation dependent, order
unbound Namespace URI	empty `Iterator`
`XMLConstants.XML_NS_URI` ("http://www.w3.org/XML/1998/namespace")	`Iterator` with one element set to `XMLConstants.XML_NS_PREFIX` ("xml")
`XMLConstants.XMLNS_ATTRIBUTE_NS_URI` ("http://www.w3.org/2000/xmlns/")	`Iterator` with one element set to `XMLConstants.XMLNS_ATTRIBUTE` ("xmlns")
`null`	`IllegalArgumentException` is thrown

Parameters

nsURI:String: URI of Namespace to lookup

Returns:Iterator<String>

Iterator for all prefixes bound to the Namespace URI in the current scope

Annotations

@Override

getTopElementDesc	back to summary
public final String getTopElementDesc()

getTotalNsCount	back to summary
public final int getTotalNsCount() Returns:int Number of active prefix/namespace mappings for current scope, including mappings from enclosing elements.

getValidationLocation

back to summary

public Location getValidationLocation()

Implements org.codehaus.stax2.validation.ValidationContext.getValidationLocation.

Doc from org.codehaus.stax2.validation.ValidationContext.getValidationLocation.

Method that will return the location that best represents current location within document to be validated, if such information is available.

Note

it is likely that even when a location is known, it may not be very accurate; for example, when attributes are validated, it is possible that they all would point to a single location that may point to the start of the element that contains attributes.

Annotations

@Override

getXmlVersion

back to summary

public final String getXmlVersion()

Implements org.codehaus.stax2.validation.ValidationContext.getXmlVersion.

Doc from org.codehaus.stax2.validation.ValidationContext.getXmlVersion.

Method that validator can call to figure out which xml version document being validated declared (if none, "1.0" is assumed as per xml specifications 1.0 and 1.1).

Returns:String

Xml version of the document: currently has to be either "1.0" or "1.1".

Annotations

@Override

isEmpty	back to summary
public final boolean isEmpty()

isNamespaceAware	back to summary
public final boolean isNamespaceAware()

isNotationDeclared

back to summary

public boolean isNotationDeclared(String name)

Implements org.codehaus.stax2.validation.ValidationContext.isNotationDeclared.

Returns:boolean

Doc from org.codehaus.stax2.validation.ValidationContext.isNotationDeclared.

True, if a notation with specified name has been declared in the document being validated; false if not.

Annotations

@Override

isPrefixLocallyDeclared	back to summary
public boolean isPrefixLocallyDeclared(String internedPrefix)

isUnparsedEntityDeclared

back to summary

public boolean isUnparsedEntityDeclared(String name)

Implements org.codehaus.stax2.validation.ValidationContext.isUnparsedEntityDeclared.

Returns:boolean

Doc from org.codehaus.stax2.validation.ValidationContext.isUnparsedEntityDeclared.

True, if an unparsed entity with specified name has been declared in the document being validated; false if not.

Annotations

@Override

matches	back to summary
public final boolean matches(String prefix, String localName)

pop

back to summary

public final boolean pop() throws XMLStreamException

Method called by the stream reader to remove the topmost (start) element from the stack; called when an end element is encountered during parsing.

Returns:boolean: True if stack has more elements; false if not (that is, root element closed)

push	back to summary
public final void push(String prefix, String localName) throws XMLStreamException Method called by the stream reader to add new (start) element into the stack in namespace-aware mode; called when a start element is encountered during parsing, but only in ns-aware mode.

reallyValidating back to summary

protected boolean reallyValidating()

This is a method called by the reader to ensure that we have at least one 'real' validator. This is only needed to ensure that validation problems that the reader can detect (illegal textual content) can be reported as validity errors. Since the validator API does not have a good way to cleanly deal with such a possibility, the check is rather fragile, but should work for now: essentially we need at least one validator object that either is not a sub-class of DTDValidatorBase or returns true for reallyValidating.

!!! TODO: remove need for this method (and method itself) with Woodstox 4.0, by adding necessary support in Stax2 XMLValidator interface.

reportProblem back to summary

public void reportProblem(XMLValidationProblem problem) throws XMLStreamException

Implements org.codehaus.stax2.validation.ValidationContext.reportProblem.

Doc from org.codehaus.stax2.validation.ValidationContext.reportProblem.

Method called by the validator, upon encountering a validation problem. Implementations are encouraged to allow an optional ValidationProblemHandler be set by the application, to define handling.

Note

Stax2 version 2 only allowed throwing instances of XMLValidationProblem; version 3 allows generic base class to be thrown, to support other interfaces such as basic Stax interface javax.xml.stream.XMLReporter.

Annotations

@Override

resolveAndValidateElement

back to summary

public int resolveAndValidateElement() throws XMLStreamException

Method called to resolve element and attribute namespaces (in namespace-aware mode), and do optional validation using pluggable validator object.

Returns:int: Text content validation state that should be effective for the fully resolved element context

setAutomaticDTDValidator	back to summary
protected void setAutomaticDTDValidator(XMLValidator validator, NsDefaultProvider nsDefs) Method called to connect the automatically handled DTD validator (one detected from DOCTYPE, loaded and completely handled by the stream reader without application calling validation methods). Handled separately, since its behaviour is potentially different from that of explicitly added validators.

stopValidatingAgainst	back to summary
public XMLValidator stopValidatingAgainst(XMLValidationSchema schema) throws XMLStreamException

stopValidatingAgainst	back to summary
public XMLValidator stopValidatingAgainst(XMLValidator validator) throws XMLStreamException

throwIllegalIndex	back to summary
private void throwIllegalIndex(int index, int localCount)

validateAgainst	back to summary
public XMLValidator validateAgainst(XMLValidationSchema schema) throws XMLStreamException

validateEndElement

back to summary

public int validateEndElement() throws XMLStreamException

Method called after parsing (but before returning) end element, to allow for pluggable validators to verify correctness of the content model for the closing element.

Returns:int: Validation state that should be effective for the parent element state

validateText	back to summary
public final void validateText(TextBuffer tb, boolean lastTextSegment) throws XMLStreamException

validateText	back to summary
public final void validateText(String contents, boolean lastTextSegment) throws XMLStreamException

public final Class InputElementStack

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail