org.sonar.api.batch

Interface SensorContext

public interface SensorContext

Since:

1.10

Method Summary

Methods

Modifier and Type	Method and Description
Event	createEvent(Resource resource, String name, String description, String category, Date date) Creates an event for a given date
void	deleteEvent(Event event) Deletes an event
void	deleteLink(String key) remove a link.
Collection<Resource>	getChildren(Resource reference)
Set<Dependency>	getDependencies()
List<Event>	getEvents(Resource resource)
Collection<Dependency>	getIncomingDependencies(Resource to)
Measure	getMeasure(Metric metric) Find a project measure
Measure	getMeasure(Resource resource, Metric metric) Find a measure for this project
<M> M	getMeasures(MeasuresFilter<M> filter) All measures of the project.
<M> M	getMeasures(Resource resource, MeasuresFilter<M> filter) Find all measures for this project.
Collection<Dependency>	getOutgoingDependencies(Resource from)
Resource	getParent(Resource reference)
<R extends Resource> R	getResource(R reference) Search for an indexed resource.
boolean	index(Resource resource) Indexes a resource as a direct child of project.
boolean	index(Resource resource, Resource parentReference) Indexes a resource.
boolean	isExcluded(Resource reference) Returns true if the referenced resource is indexed and excluded.
boolean	isIndexed(Resource reference, boolean acceptExcluded) Returns true if the referenced resource is indexed.
Dependency	saveDependency(Dependency dependency) Build a new dependency : from depends upon to.
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, Double value) Add a measure on project
Measure	saveMeasure(Resource resource, Measure measure) Add or update a measure.
Measure	saveMeasure(Resource resource, Metric metric, Double value) Add or update a measure.
String	saveResource(Resource resource) Deprecated. use the methods index()
void	saveSource(Resource reference, String source) Save the source code of a file.
void	saveViolation(Violation violation) Save a coding rule violation.
void	saveViolation(Violation violation, boolean force) Save a coding rule violation.
void	saveViolations(Collection<Violation> violations) Saves a list of violations.

Method Detail

index

boolean index(Resource resource)

Indexes a resource as a direct child of project. This method does nothing and returns true if the resource already indexed.

Returns:

false if the resource is excluded

Since:

2.6

index

boolean index(Resource resource,
            Resource parentReference)

Indexes a resource. This method does nothing if the resource is already indexed.

Parameters:

resource - the resource to index. Not nullable

parentReference - a reference to the parent. If null, the the resource is indexed as a direct child of project.

Returns:

false if the parent is not indexed or if the resource is excluded

Since:

2.6

isExcluded

boolean isExcluded(Resource reference)

Returns true if the referenced resource is indexed and excluded.

Since:

2.6

isIndexed

boolean isIndexed(Resource reference,
                boolean acceptExcluded)

Returns true if the referenced resource is indexed.

Since:

2.6

getResource

<R extends Resource> R getResource(R reference)

Search for an indexed resource.

Parameters:

reference - the resource reference

Returns:

the indexed resource, null if it's not indexed

Since:

1.10. Generic types since 2.6.

getParent

Resource getParent(Resource reference)

Since:

2.6

getChildren

Collection<Resource> getChildren(Resource reference)

Since:

2.6

getMeasure

Measure getMeasure(Metric metric)

Find a project measure

getMeasures

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

All measures of the project. Never return null.

saveMeasure

Measure saveMeasure(Measure measure)

Add a measure on project

saveMeasure

Measure saveMeasure(Metric metric,
                  Double value)

Add a measure on project

getMeasure

Measure getMeasure(Resource resource,
                 Metric metric)

Find a measure for this project

saveResource

@Deprecated
String saveResource(Resource resource)

Deprecated. use the methods index()

Key is updated when saving the resource.

Returns:

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

getMeasures

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

Find all measures for this project. Never return null.

saveMeasure

Measure saveMeasure(Resource resource,
                  Metric metric,
                  Double value)

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.

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(Violation violation,
                 boolean force)

Save a coding rule violation.

Parameters:

force - allows to force creation of violation even if it was supressed by ViolationFilter

Since:

2.5

saveViolation

void saveViolation(Violation violation)

Save a coding rule violation.

saveViolations

void saveViolations(Collection<Violation> violations)

Saves a list of violations.

saveDependency

Dependency saveDependency(Dependency dependency)

Build a new dependency : from depends upon to. The dependency is NOT saved. The method saveDependency() must still be executed.

getDependencies

Set<Dependency> getDependencies()

getIncomingDependencies

Collection<Dependency> getIncomingDependencies(Resource to)

getOutgoingDependencies

Collection<Dependency> getOutgoingDependencies(Resource from)

saveSource

void saveSource(Resource reference,
              String source)

Save the source code of a file. The file must be have been indexed before.

Throws:

DuplicatedSourceException - if the source has already been set on this resource

Since:

1.10. Returns a boolean since 2.6.

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(String key)

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

getEvents

List<Event> getEvents(Resource resource)

Parameters:

resource - set null for project events

createEvent

Event createEvent(Resource resource,
                String name,
                String description,
                String category,
                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

deleteEvent

void deleteEvent(Event event)

Deletes an event

Parameters:

event - the event to delete