hudson.plugins.checkstyle.parser
Class Warning

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

All Implemented Interfaces:

hudson.plugins.analysis.util.model.FileAnnotation, java.io.Serializable, java.lang.Comparable<hudson.plugins.analysis.util.model.FileAnnotation>

public class Warning
extends hudson.plugins.analysis.util.model.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

Field Summary

static java.lang.String

ORIGIN Origin of the annotation.

Fields inherited from class hudson.plugins.analysis.util.model.AbstractAnnotation

WORKSPACE_FILES

Constructor Summary

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

Warning(hudson.plugins.analysis.util.model.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()

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

addLineRange, canDisplayFile, compareTo, equals, getCategory, getContextHashCode, getFileName, getKey, getLineRanges, getMessage, getModuleName, getOrigin, getPackageName, getPrimaryLineNumber, getPriority, getShortFileName, getTempName, getType, hashCode, hasPackageName, setContextHashCode, setFileName, setModuleName, setOrigin, setPackageName, setPriority

Methods inherited from class java.lang.Object

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

Field Detail

ORIGIN

public static final java.lang.String ORIGIN

Origin of the annotation.

See Also:

Constant Field Values

Constructor Detail

Warning

public Warning(hudson.plugins.analysis.util.model.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(hudson.plugins.analysis.util.model.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()