Package org.infinispan.configuration.parsing

Interface XMLExtendedStreamReader

  • All Superinterfaces:
    javax.xml.stream.XMLStreamConstants, javax.xml.stream.XMLStreamReader
    public interface XMLExtendedStreamReader
extends javax.xml.stream.XMLStreamReader
    An XML stream reader that can read nested <xs:any> content using a registered set of root elements.
    Since:
    6.0
    Author:
    David M. Lloyd

    • 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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String[] getListAttributeValue​(int i)
      Get the value of an attribute as a space-delimited string list.
      java.util.Properties getProperties()
      Returns the properties used for property-replacement
      XMLResourceResolver getResourceResolver()
      Returns the XMLResourceResolver used to resolve resources
      Schema getSchema()
      Returns the schema of currently being processed
      void handleAny​(ConfigurationBuilderHolder holder)
      Handle an <xs:any>-type nested element, passing in the given value, returning after the end of the element.
      void setSchema​(Schema schema)
      Sets the current schema

      • Methods inherited from interface javax.xml.stream.XMLStreamReader

        close, getAttributeCount, getAttributeLocalName, getAttributeName, getAttributeNamespace, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getCharacterEncodingScheme, getElementText, getEncoding, getEventType, getLocalName, getLocation, getName, getNamespaceContext, getNamespaceCount, getNamespacePrefix, getNamespaceURI, getNamespaceURI, getNamespaceURI, getPIData, getPITarget, getPrefix, getProperty, getText, getTextCharacters, getTextCharacters, getTextLength, getTextStart, getVersion, hasName, hasNext, hasText, isAttributeSpecified, isCharacters, isEndElement, isStandalone, isStartElement, isWhiteSpace, next, nextTag, require, standaloneSet

    • Method Detail

      • handleAny

        void handleAny​(ConfigurationBuilderHolder holder)
        throws javax.xml.stream.XMLStreamException
        Handle an <xs:any>-type nested element, passing in the given value, returning after the end of the element. Must be positioned on a START_ELEMENT or an exception will occur. On return the cursor will be positioned on the corresponding END_ELEMENT.
        Parameters:
        holder - a ConfigurationBuilderHolder
        Throws:
        javax.xml.stream.XMLStreamException - if an error occurs (e.g. the given value does not match the type of the handler for the element, or the element is unknown)

      • getListAttributeValue

        java.lang.String[] getListAttributeValue​(int i)
        Get the value of an attribute as a space-delimited string list.
        Parameters:
        i - the index of the attribute

      • getSchema

        Schema getSchema()
        Returns the schema of currently being processed
        Returns:
        schema the current schema

      • setSchema

        void setSchema​(Schema schema)
        Sets the current schema
        Parameters:
        schema -

      • getProperties

        java.util.Properties getProperties()
        Returns the properties used for property-replacement
        Returns:
        the properties