|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.mylyn.wikitext.core.validation.ValidationProblem
public class ValidationProblem
A validation problem is an indication of an error or warning that occurred while validating a document. A problem has a marker id, severity, message, and optional offset and length. Default comparison semantics order problems by increasing offset.
Nested Class Summary | |
---|---|
static class |
ValidationProblem.Severity
|
Field Summary | |
---|---|
static String |
DEFAULT_MARKER_ID
The default marker id for a WikiText validation problem. |
Constructor Summary | |
---|---|
ValidationProblem(ValidationProblem.Severity severity,
String message,
int offset,
int length)
create a validation problem |
Method Summary | |
---|---|
int |
compareTo(ValidationProblem o2)
|
int |
getLength()
the length of the problem in characters |
String |
getMarkerId()
|
String |
getMessage()
the text message as it is displayed to the user |
int |
getOffset()
the character offset in the document of the problem |
ValidationProblem.Severity |
getSeverity()
|
void |
setLength(int length)
|
void |
setMarkerId(String markerId)
|
void |
setMessage(String message)
|
void |
setOffset(int offset)
|
void |
setSeverity(ValidationProblem.Severity severity)
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_MARKER_ID
Constructor Detail |
---|
public ValidationProblem(ValidationProblem.Severity severity, String message, int offset, int length)
severity
- a severity indicating the severity of the problemmessage
- the message describing the problemoffset
- the offset into the document that the problem startslength
- the length of the problem, which may be 0
IllegalArgumentException
- if the severity is invalid, the offset is < 0, the length is < 0, or if no message is providedMethod Detail |
---|
public String getMarkerId()
public void setMarkerId(String markerId)
public ValidationProblem.Severity getSeverity()
public void setSeverity(ValidationProblem.Severity severity)
severity
- a severitypublic String getMessage()
public void setMessage(String message)
message
- the text message as it is displayed to the userpublic int getOffset()
public void setOffset(int offset)
public int getLength()
public void setLength(int length)
public String toString()
toString
in class Object
public int compareTo(ValidationProblem o2)
compareTo
in interface Comparable<ValidationProblem>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |