Class XMLValidationProblem

java.lang.Object
org.codehaus.stax2.validation.XMLValidationProblem

public class XMLValidationProblem extends 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 Details

    • SEVERITY_WARNING

      public static final int SEVERITY_WARNING
      See Also:
    • SEVERITY_ERROR

      public static final int SEVERITY_ERROR
      See Also:
    • SEVERITY_FATAL

      public static final int SEVERITY_FATAL
      See Also:
    • mLocation

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

      protected final String mMessage
    • mSeverity

      protected final int mSeverity
    • mType

      protected 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 Details

    • XMLValidationProblem

      public XMLValidationProblem(Location loc, String msg)
    • XMLValidationProblem

      public XMLValidationProblem(Location loc, String msg, int severity)
    • XMLValidationProblem

      public XMLValidationProblem(Location loc, String msg, int severity, String type)
  • Method Details

    • 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(String t)
      Since:
      3.0
    • setLocation

      public void setLocation(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 Location getLocation()
      Returns:
      Reference to location where problem was encountered.
    • getMessage

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

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

      public 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