org.sonar.api.batch
Interface SensorContext

public interface SensorContext

Method Summary

Event	createEvent(Resource<?> resource, java.lang.String name, java.lang.String description, java.lang.String category, java.util.Date date) Creates an event for a given date
Event	createEventOnCurrentSnapshot(Resource<?> resource, java.lang.String name, java.lang.String description, java.lang.String category) Creates an event for the given analysis
void	deleteEvent(Event event) Deletes an event
void	deleteLink(java.lang.String key) remove a link.
java.util.List<Event>	getEvents(Resource<?> resource)
Measure	getMeasure(Metric metric) Find a measure for this project
Measure	getMeasure(Resource<?> resource, Metric metric) Find a measure for this project
<M> M	getMeasures(MeasuresFilter<M> filter) Find all measures for this project.
<M> M	getMeasures(Resource<?> resource, MeasuresFilter<M> filter) Find all measures for this project.
Project	getProject()
void	saveLink(ProjectLink link) add a link to an external page like project homepage, sources (subversion, ...), continuous integration server...
Measure	saveMeasure(Measure measure) Add a measure on project
Measure	saveMeasure(Metric metric, java.lang.Double value) Add a measure on project
Measure	saveMeasure(Resource<?> resource, Measure measure) Add or update a measure.
Measure	saveMeasure(Resource<?> resource, Metric metric, java.lang.Double value)
java.lang.String	saveResource(Resource<?> resource) Key is updated when saving the resource.
void	saveSource(Resource<?> resource, java.lang.String source) Does nothing if the resource is set as excluded.
void	saveViolation(Resource<?> resource, Rule rule, java.lang.String message, RulePriority priority, java.lang.Integer lineId) Does nothing if the resource is set as excluded.
void	saveViolation(Resource<?> resource, Rule rule, java.lang.String message, RulePriority priority, ViolationParam... params) Does nothing if the resource is set as excluded.

Method Detail

getProject

Project getProject()

getMeasure

Measure getMeasure(Metric metric)

Find a measure for this project

getMeasures

<M> M getMeasures(MeasuresFilter<M> filter)

Find all measures for this project. Never return null.

saveMeasure

Measure saveMeasure(Measure measure)

Add a measure on project

saveMeasure

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

Add a measure on project

getMeasure

Measure getMeasure(Resource<?> resource,
                   Metric metric)

Find a measure for this project

getMeasures

<M> M getMeasures(Resource<?> resource,
                  MeasuresFilter<M> filter)

Find all measures for this project. Never return null.

saveResource

java.lang.String saveResource(Resource<?> resource)

Key is updated when saving the resource.

Returns:

the key as saved in database. Null if the resource is set as excluded.

saveMeasure

Measure saveMeasure(Resource<?> resource,
                    Metric metric,
                    java.lang.Double value)

saveMeasure

Measure saveMeasure(Resource<?> resource,
                    Measure measure)

Add or update a measure.

The resource is automatically saved, so there is no need to execute the method saveResource(). Does nothing if the resource is set as excluded.

saveViolation

void saveViolation(Resource<?> resource,
                   Rule rule,
                   java.lang.String message,
                   RulePriority priority,
                   java.lang.Integer lineId)

Does nothing if the resource is set as excluded.

Parameters:

lineId - (optional), from 1.

saveViolation

void saveViolation(Resource<?> resource,
                   Rule rule,
                   java.lang.String message,
                   RulePriority priority,
                   ViolationParam... params)

Does nothing if the resource is set as excluded.

saveSource

void saveSource(Resource<?> resource,
                java.lang.String source)

Does nothing if the resource is set as excluded.

saveLink

void saveLink(ProjectLink link)

add a link to an external page like project homepage, sources (subversion, ...), continuous integration server... Example : context.addLink(new ProjectLink("maven_site, "Maven site", "http://my.maven.com)

deleteLink

void deleteLink(java.lang.String key)

remove a link. It does not fail if key is unknown.

getEvents

java.util.List<Event> getEvents(Resource<?> resource)

Parameters:

resource - set null for project events

createEvent

Event createEvent(Resource<?> resource,
                  java.lang.String name,
                  java.lang.String description,
                  java.lang.String category,
                  java.util.Date date)

Creates an event for a given date

Parameters:

name - the event name

description - the event description

category - the event category

date - the event date

Returns:

the created event

createEventOnCurrentSnapshot

Event createEventOnCurrentSnapshot(Resource<?> resource,
                                   java.lang.String name,
                                   java.lang.String description,
                                   java.lang.String category)

Creates an event for the given analysis

Parameters:

name - the event name

description - the event description

category - the event category

Returns:

the created event

deleteEvent

void deleteEvent(Event event)

Deletes an event

Parameters:

event - the event to delete