hudson.plugins.warnings.parser
Class Warning

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

All Implemented Interfaces:

FileAnnotation, java.io.Serializable

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(java.lang.String fileName, int start, java.lang.String type, java.lang.String category, java.lang.String message)
Creates a new instance of Warning.

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

Method Summary

java.lang.String	getToolTip() Returns the a detailed description that will be used as tooltip.
boolean	hasPackageName() Returns whether a package name has been defined.

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

addLineRange, canDisplayFile, 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(java.lang.String fileName,
               int start,
               java.lang.String type,
               java.lang.String category,
               java.lang.String message)

Creates a new instance of Warning.

Parameters:

fileName - the name of the file

start - the first line of the line range

type - the identifier of the warning type

category - the warning category

message - the message of the warning

Warning

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

Creates a new instance of Warning.

Parameters:

fileName - the name of the file

start - the first line of the line range

type - the identifier of the warning type

category - the warning category

message - the message of the warning

priority - the priority of the warning

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

hasPackageName

public boolean hasPackageName()

Returns whether a package name has been defined.

Returns:

true, if a package name has been defined