hudson.plugins.tasks.parser
Class Task

java.lang.Object
  hudson.plugins.tasks.util.model.AbstractAnnotation
      hudson.plugins.tasks.parser.Task

All Implemented Interfaces:

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

public class Task
extends AbstractAnnotation

A serializable Java Bean class representing an open task.

Author:

Ulli Hafner

See Also:

Serialized Form

Field Summary

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

WORKSPACE_FILES

Constructor Summary

Task(Priority priority, int lineNumber, java.lang.String taskTag, java.lang.String message)
Creates a new instance of Task.

Method Summary

java.lang.String	getDetailMessage() Returns the detail message of the task (the text after the task keyword).
java.lang.String	getMatch() Gets the matching text of a tasks including the tag.
java.lang.String	getMessage() Returns the message of this annotation.
java.lang.String	getToolTip() Returns the a detailed description that will be used as tooltip.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task(Priority priority,
            int lineNumber,
            java.lang.String taskTag,
            java.lang.String message)

Creates a new instance of Task.

Parameters:

priority - the priority

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

taskTag - the found task tag

message - the message of the task (the text after the task keyword)

Method Detail

getDetailMessage

public java.lang.String getDetailMessage()

Returns the detail message of the task (the text after the task keyword).

Returns:

the detail message of the task

getMessage

public java.lang.String getMessage()

Returns the message of this annotation.

Specified by:

getMessage in interface FileAnnotation

Overrides:

getMessage in class AbstractAnnotation

Returns:

the message of this annotation

getToolTip

public java.lang.String getToolTip()

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

Returns:

the tooltip of this annotation

getMatch

public java.lang.String getMatch()

Gets the matching text of a tasks including the tag.

Returns:

the match