org.codehaus.stax2.validation
Class XMLValidationProblem

java.lang.Object
  extended by 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 Summary
protected  Location mLocation
          Location within validated xml stream where the problem occured.
protected  String mMessage
           
protected  XMLValidator mReporter
          Validator instance that reported the problem, if any (may be null if stream reader or writer itself reported the problem)
protected  int mSeverity
           
protected  String mType
          Type of the problem, available types implementation specified.
static int SEVERITY_ERROR
           
static int SEVERITY_FATAL
           
static int SEVERITY_WARNING
           
 
Constructor Summary
XMLValidationProblem(Location loc, String msg)
           
XMLValidationProblem(Location loc, String msg, int severity)
           
XMLValidationProblem(Location loc, String msg, int severity, String type)
           
 
Method Summary
 Location getLocation()
           
 String getMessage()
           
 XMLValidator getReporter()
          Returns the validator that reported the problem if known.
 int getSeverity()
           
 String getType()
           
 void setLocation(Location l)
           
 void setReporter(XMLValidator v)
          Set the validator object that reported this problem, if known.
 void setType(String t)
           
 XMLValidationException toException()
          Convenience method for constructing a XMLValidationException to throw based on information contained in this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SEVERITY_WARNING

public static final int SEVERITY_WARNING
See Also:
Constant Field Values

SEVERITY_ERROR

public static final int SEVERITY_ERROR
See Also:
Constant Field Values

SEVERITY_FATAL

public static final int SEVERITY_FATAL
See Also:
Constant Field Values

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 Detail

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 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(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


Copyright © 2011 Codehaus. All Rights Reserved.