Class XMLValidationProblem


  • public class XMLValidationProblem
    extends java.lang.Object
    Simple container class used to store a non-fatal problem either to be returned as is, or to use for creating and throwing a validation exception.
    • Field Detail

      • mLocation

        protected javax.xml.stream.Location mLocation
        Location within validated xml stream where the problem occured.
      • mMessage

        protected final java.lang.String mMessage
      • mSeverity

        protected final int mSeverity
      • mType

        protected java.lang.String mType
        Type of the problem, available types implementation specified.
        Since:
        3.0
      • mReporter

        protected XMLValidator mReporter
        Validator instance that reported the problem, if any (may be null if stream reader or writer itself reported the problem)
        Since:
        3.0
    • Constructor Detail

      • XMLValidationProblem

        public XMLValidationProblem​(javax.xml.stream.Location loc,
                                    java.lang.String msg)
      • XMLValidationProblem

        public XMLValidationProblem​(javax.xml.stream.Location loc,
                                    java.lang.String msg,
                                    int severity)
      • XMLValidationProblem

        public XMLValidationProblem​(javax.xml.stream.Location loc,
                                    java.lang.String msg,
                                    int severity,
                                    java.lang.String type)
    • Method Detail

      • toException

        public XMLValidationException toException()
        Convenience method for constructing a XMLValidationException to throw based on information contained in this object. Base implementation is equivalent to:
          return XMLValidationException.createException(this);
        
        Since:
        3.0
      • setType

        public void setType​(java.lang.String t)
        Since:
        3.0
      • setLocation

        public void setLocation​(javax.xml.stream.Location l)
        Since:
        3.0
      • setReporter

        public void setReporter​(XMLValidator v)
        Set the validator object that reported this problem, if known.
        Since:
        3.0
      • getLocation

        public javax.xml.stream.Location getLocation()
        Returns:
        Reference to location where problem was encountered.
      • getMessage

        public java.lang.String getMessage()
        Returns:
        Human-readable message describing the problem
      • getSeverity

        public int getSeverity()
        Returns:
        One of SEVERITY_ constants (such as SEVERITY_WARNING
      • getType

        public java.lang.String getType()
        Returns:
        Generic type (class) of the problem; may be null if validator does not provide such details
        Since:
        3.0
      • getReporter

        public XMLValidator getReporter()
        Returns the validator that reported the problem if known.
        Returns:
        Validator that reported the problem; null if unknown or N/A.
        Since:
        3.0