Package org.codehaus.stax2.validation

Class ValidatorPair

  • public class ValidatorPair
extends XMLValidator
    Simple utility class that allows chaining of XMLValidator instances. Since the class itself implements XMLValidator, multiple validators can be added by chaining these pairs; ordering of validator calls depends on ordering of the pairs.

    Default semantics are quite simple: first validator of the pair is always called first, and results as/if modified by that validator are passed on to the second validator.

    It is expected that this class is mostly used by actual stream reader and writer implementations; not so much by validator implementations.

    • Method Detail

      • getSchema

        public XMLValidationSchema getSchema()
        Two choices here; could either return schema of the first child, or return null. Let's do latter, do avoid accidental matches.
        Specified by:
        getSchema in class XMLValidator

      • validateAttribute

        public String validateAttribute​(String localName,
                                String uri,
                                String prefix,
                                String value)
                         throws XMLStreamException
        Description copied from class: XMLValidator
        Callback method called on validator to give it a chance to validate the value of an attribute, as well as to normalize its value if appropriate (remove leading/trailing/intervening white space for certain token types etc.).
        Specified by:
        validateAttribute in class XMLValidator
        Returns:
        Null, if the passed value is fine as is; or a String, if it needs to be replaced. In latter case, caller will replace the value before passing it to other validators. Also, if the attribute value is accessible via caller (as is the case for stream readers), caller should return this value, instead of the original one.
        Throws:
        XMLStreamException

      • validateAttribute

        public String validateAttribute​(String localName,
                                String uri,
                                String prefix,
                                char[] valueChars,
                                int valueStart,
                                int valueEnd)
                         throws XMLStreamException
        Description copied from class: XMLValidator
        Callback method called on validator to give it a chance to validate the value of an attribute, as well as to normalize its value if appropriate (remove leading/trailing/intervening white space for certain token types etc.).
        Specified by:
        validateAttribute in class XMLValidator
        valueChars - Character array that contains value (possibly along with some other text)
        valueStart - Index of the first character of the value in in valueChars array
        valueEnd - Index of the character AFTER the last character; so that the length of the value String is valueEnd - valueStart
        Returns:
        Null, if the passed value is fine as is; or a String, if it needs to be replaced. In latter case, caller will replace the value before passing it to other validators. Also, if the attribute value is accessible via caller (as is the case for stream readers), caller should return this value, instead of the original one.
        Throws:
        XMLStreamException

      • validateText

        public void validateText​(char[] cbuf,
                         int textStart,
                         int textEnd,
                         boolean lastTextSegment)
                  throws XMLStreamException
        Description copied from class: XMLValidator
        Method called to validate textual content.

        Note: this method is only guaranteed to be called when XMLValidator.validateElementAndAttributes() for the currently open element returned XMLValidator.CONTENT_ALLOW_VALIDATABLE_TEXT (or, in case of mixed content, XMLValidator.validateElementEnd(java.lang.String, java.lang.String, java.lang.String), for the last enclosed element). Otherwise, validator context may choose not to call the method as an optimization.

        Specified by:
        validateText in class XMLValidator
        Parameters:
        cbuf - Character array that contains text content to validate
        textStart - Index of the first character of the content to validate
        textEnd - Character following the last character of the content to validate (that is, length of content to validate is textEnd - textStart).
        lastTextSegment - Whether this text content is the last text segment before a close element; true if it is, false if it is not, or no determination can be made. Can be used for optimizing validation -- if this is true, no text needs to be buffered since no more will be sent before the current element closes.
        Throws:
        XMLStreamException

      • validationCompleted

        public void validationCompleted​(boolean eod)
                         throws XMLStreamException
        Description copied from class: XMLValidator
        Method called when the validation is completed; either due to the input stream ending, or due to an explicit 'stop validation' request by the application (via context object).
        Specified by:
        validationCompleted in class XMLValidator
        Parameters:
        eod - Flag that indicates whether this method was called by the context due to the end of the stream (true); or by an application requesting end of validation (false).
        Throws:
        XMLStreamException

      • getAttributeType

        public String getAttributeType​(int index)
        Description copied from class: XMLValidator
        Method for getting schema-specified type of an attribute, if information is available. If not, validators can return null to explicitly indicate no information was available.
        Specified by:
        getAttributeType in class XMLValidator

      • getIdAttrIndex

        public int getIdAttrIndex()
        Description copied from class: XMLValidator
        Method for finding out the index of the attribute that is of type ID; derived from DTD, W4C Schema, or some other validation source. Usually schemas explicitly specifies that at most one attribute can have this type for any element.
        Specified by:
        getIdAttrIndex in class XMLValidator
        Returns:
        Index of the attribute with type ID, in the current element, if one exists: -1 otherwise

      • getNotationAttrIndex

        public int getNotationAttrIndex()
        Description copied from class: XMLValidator
        Method for finding out the index of the attribute (collected using the attribute collector; having DTD/Schema-derived info in same order) that is of type NOTATION. DTD explicitly specifies that at most one attribute can have this type for any element.
        Specified by:
        getNotationAttrIndex in class XMLValidator
        Returns:
        Index of the attribute with type NOTATION, in the current element, if one exists: -1 otherwise