public interface SensorContext
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> |
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.
|
boolean index(Resource resource)
boolean index(Resource resource, Resource parentReference)
resource
- the resource to index. Not nullableparentReference
- a reference to the parent. If null, the the resource is indexed as a direct child of project.boolean isExcluded(Resource reference)
boolean isIndexed(Resource reference, boolean acceptExcluded)
<R extends Resource> R getResource(R reference)
reference
- the resource referenceCollection<Resource> getChildren(Resource reference)
Measure getMeasure(Metric metric)
<M> M getMeasures(MeasuresFilter<M> filter)
Measure saveMeasure(Measure measure)
Measure saveMeasure(Metric metric, Double value)
Measure getMeasure(Resource resource, Metric metric)
@Deprecated String saveResource(Resource resource)
<M> M getMeasures(Resource resource, MeasuresFilter<M> filter)
Measure saveMeasure(Resource resource, Metric metric, Double value)
The resource is automatically saved, so there is no need to execute the method saveResource(). Does nothing if the resource is set as excluded.
Measure saveMeasure(Resource resource, Measure 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.
void saveViolation(Violation violation, boolean force)
force
- allows to force creation of violation even if it was supressed by ViolationFilter
void saveViolation(Violation violation)
void saveViolations(Collection<Violation> violations)
Dependency saveDependency(Dependency dependency)
Set<Dependency> getDependencies()
Collection<Dependency> getIncomingDependencies(Resource to)
Collection<Dependency> getOutgoingDependencies(Resource from)
void saveSource(Resource reference, String source)
DuplicatedSourceException
- if the source has already been set on this resourcevoid saveLink(ProjectLink link)
void deleteLink(String key)
List<Event> getEvents(Resource resource)
resource
- set null for project eventsEvent createEvent(Resource resource, String name, String description, String category, Date date)
name
- the event namedescription
- the event descriptioncategory
- the event categorydate
- the event datevoid deleteEvent(Event event)
event
- the event to deleteCopyright © 2009-2013 SonarSource. All Rights Reserved.