hudson.plugins.checkstyle.parser
Class Warning

java.lang.Object
  hudson.plugins.checkstyle.util.model.AbstractAnnotation
      hudson.plugins.checkstyle.parser.Warning

All Implemented Interfaces:

FileAnnotation, java.io.Serializable, java.lang.Comparable<FileAnnotation>

public class Warning
extends AbstractAnnotation

A serializable Java Bean class representing a warning.

Note: this class has a natural ordering that is inconsistent with equals.

Author:

Ulli Hafner

See Also:

Serialized Form

Constructor Summary

Warning(Priority priority, java.lang.String message, java.lang.String category, java.lang.String type, int lineNumber)
Creates a new instance of Warning.

Warning(Priority priority, java.lang.String message, java.lang.String category, java.lang.String type, int start, int end)
Creates a new instance of Warning.

Method Summary

java.lang.String

getToolTip() Returns the a detailed description that will be used as tooltip.

Methods inherited from class hudson.plugins.checkstyle.util.model.AbstractAnnotation

addLineRange, canDisplayFile, compareTo, equals, getCategory, getFileName, getKey, getLineRanges, getMessage, getModuleName, getPackageName, getPrimaryLineNumber, getPriority, getShortFileName, getTempName, getType, hashCode, setFileName, setModuleName, setPackageName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Warning

public Warning(Priority priority,
               java.lang.String message,
               java.lang.String category,
               java.lang.String type,
               int start,
               int end)

Creates a new instance of Warning.

Parameters:

priority - the priority

message - the message of the warning

category - the warning category

type - the identifier of the warning type

start - the first line of the line range

end - the last line of the line range

Warning

public Warning(Priority priority,
               java.lang.String message,
               java.lang.String category,
               java.lang.String type,
               int lineNumber)

Creates a new instance of Warning.

Parameters:

priority - the priority

message - the message of the warning

category - the warning category

type - the identifier of the warning type

lineNumber - the line number of the warning in the corresponding file

Method Detail

getToolTip

public java.lang.String getToolTip()

Returns the a detailed description that will be used as tooltip.

Returns:

the tooltip of this annotation