org.sonar.plugins.api.jobs
Interface JobContext

All Known Implementing Classes:

JobContextImpl

public interface JobContext

A JobContext is linked to a resource (class, package, project, file...). It is used to read and write measures.

Method Summary

Measure	addMeasure(Measure measure)
Measure	addMeasure(Metric metric, java.lang.Double value)
Measure	addMeasure(Metric metric, java.lang.String value)
Event	createEvent(java.lang.String name, java.lang.String description, java.lang.String category, java.util.Date date)
Event	createEventOnCurrentSnapshot(java.lang.String name, java.lang.String description, java.lang.String category)
void	deleteEvent(Event event)
java.util.List<JobContext>	getChildren()
java.util.List<Measure>	getChildrenMeasures()
java.util.List<Measure>	getChildrenMeasures(MeasureKey key)
java.util.List<Measure>	getChildrenMeasures(Metric metric)
java.util.List<Event>	getEvents() All events, on projects only
Measure	getMeasure(MeasureKey key)
Measure	getMeasure(Metric metric)
java.util.List<Measure>	getMeasures() Read-only measures
java.util.List<Measure>	getMeasures(MeasureKey key)
java.util.List<Measure>	getMeasures(Metric metric)
Measure	getPastMeasure(Metric metric)
Resource	getResource() The currently analysed resource
java.lang.String	getResourceVersion()
java.util.List<RuleFailure>	getRuleFailures() Read-only rule failures.
java.util.Date	getSnapshotDate()
Measure	updateMeasure(Measure measure)

Method Detail

getResource

Resource getResource()

The currently analysed resource

getSnapshotDate

java.util.Date getSnapshotDate()

getResourceVersion

java.lang.String getResourceVersion()

getRuleFailures

java.util.List<RuleFailure> getRuleFailures()

Read-only rule failures. It can be null on some types of resources (files/classes)

getMeasures

java.util.List<Measure> getMeasures()

Read-only measures

getMeasure

Measure getMeasure(MeasureKey key)

getMeasure

Measure getMeasure(Metric metric)

getPastMeasure

Measure getPastMeasure(Metric metric)

getMeasures

java.util.List<Measure> getMeasures(MeasureKey key)

getMeasures

java.util.List<Measure> getMeasures(Metric metric)

getChildren

java.util.List<JobContext> getChildren()

getChildrenMeasures

java.util.List<Measure> getChildrenMeasures()

getChildrenMeasures

java.util.List<Measure> getChildrenMeasures(MeasureKey key)

getChildrenMeasures

java.util.List<Measure> getChildrenMeasures(Metric metric)

addMeasure

Measure addMeasure(Measure measure)

addMeasure

Measure addMeasure(Metric metric,
                   java.lang.Double value)

addMeasure

Measure addMeasure(Metric metric,
                   java.lang.String value)

updateMeasure

Measure updateMeasure(Measure measure)

getEvents

java.util.List<Event> getEvents()

All events, on projects only

createEvent

Event createEvent(java.lang.String name,
                  java.lang.String description,
                  java.lang.String category,
                  java.util.Date date)

createEventOnCurrentSnapshot

Event createEventOnCurrentSnapshot(java.lang.String name,
                                   java.lang.String description,
                                   java.lang.String category)

deleteEvent

void deleteEvent(Event event)