org.incava.analysis

Class Violation

Implemented Interfaces:
Comparable

public class Violation
extends java.lang.Object
implements Comparable

An error or a warning, associated with a file by a starting and ending position, and a message.

Constructor Summary

Violation(String message, int beginLine, int beginColumn, int endLine, int endColumn)
Creates a violation from a message and begin and end positions.
Violation(String message, net.sourceforge.pmd.ast.Token token)
Creates a violation from a message and a token.
Violation(String message, net.sourceforge.pmd.ast.Token beginToken, net.sourceforge.pmd.ast.Token endToken)
Creates a violation from a message and beginning and ending token.

Method Summary

int
compareTo(Object obj)
Compares this violation to another.
boolean
equals(Object obj)
Returns whether the other object is equal to this one.
int
getBeginColumn()
Returns the column where the violation starts.
int
getBeginLine()
Returns the line where the violation starts.
int
getEndColumn()
Returns the column where the violation ends.
int
getEndLine()
Returns the line where the violation ends.
String
getMessage()
Returns the message for this violation.
String
toString()
Returns this violation, as a string.

Constructor Details

Violation

public Violation(String message,
                 int beginLine,
                 int beginColumn,
                 int endLine,
                 int endColumn)
Creates a violation from a message and begin and end positions.
Parameters:
message - The message applying to this violation.
beginLine - The line where the violation begins.
beginColumn - The column where the violation begins.
endLine - The line where the violation ends.
endColumn - The column where the violation ends.

Violation

public Violation(String message,
                 net.sourceforge.pmd.ast.Token token)
Creates a violation from a message and a token. The token image is considered to be the entire length of the violation, i.e., the ending location is token + token.image.length() - 1.
Parameters:
message - The message applying to this violation.
token - The token to which the violation applies.

Violation

public Violation(String message,
                 net.sourceforge.pmd.ast.Token beginToken,
                 net.sourceforge.pmd.ast.Token endToken)
Creates a violation from a message and beginning and ending token.
Parameters:
message - The message applying to this violation.
beginToken - The token where the violation begins.
endToken - The token where the violation ends.

Method Details

compareTo

public int compareTo(Object obj)
Compares this violation to another. Violations are sorted in order by their beginning locations, then their end locations.
Parameters:
obj - The violation to compare this to.
Returns:
-1, 0, or 1, for less than, equivalent to, or greater than.

equals

public boolean equals(Object obj)
Returns whether the other object is equal to this one. Note that messages are not compared, only line and column numbers.
Parameters:
obj - The violation to compare this to.
Returns:
Whether the other violation is equal to this one.

getBeginColumn

public int getBeginColumn()
Returns the column where the violation starts.

getBeginLine

public int getBeginLine()
Returns the line where the violation starts.

getEndColumn

public int getEndColumn()
Returns the column where the violation ends.

getEndLine

public int getEndLine()
Returns the line where the violation ends.

getMessage

public String getMessage()
Returns the message for this violation. This should be only one line, because it is used in single-line reports.

toString

public String toString()
Returns this violation, as a string.
Returns:
This violation, as a string.