|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.sonar.batch.DefaultSensorContext
public class DefaultSensorContext
Constructor Summary | |
---|---|
DefaultSensorContext(SonarIndex index,
Project project)
|
Method Summary | ||
---|---|---|
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 |
|
|
getMeasures(MeasuresFilter<M> filter)
All measures of the project. |
|
|
getMeasures(Resource resource,
MeasuresFilter<M> filter)
Find all measures for this project. |
|
Collection<Dependency> |
getOutgoingDependencies(Resource from)
|
|
Resource |
getParent(Resource reference)
|
|
Project |
getProject()
|
|
Resource |
getResource(Resource resource)
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)
Key is updated when saving the resource. |
|
boolean |
saveResource(Resource resource,
Resource parentReference)
|
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultSensorContext(SonarIndex index, Project project)
Method Detail |
---|
public Project getProject()
public boolean index(Resource resource)
SensorContext
index
in interface SensorContext
public boolean index(Resource resource, Resource parentReference)
SensorContext
index
in interface SensorContext
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.
public boolean isExcluded(Resource reference)
SensorContext
isExcluded
in interface SensorContext
public boolean isIndexed(Resource reference, boolean acceptExcluded)
SensorContext
isIndexed
in interface SensorContext
public Resource getParent(Resource reference)
getParent
in interface SensorContext
public Collection<Resource> getChildren(Resource reference)
getChildren
in interface SensorContext
public Measure getMeasure(Metric metric)
SensorContext
getMeasure
in interface SensorContext
public <M> M getMeasures(MeasuresFilter<M> filter)
SensorContext
getMeasures
in interface SensorContext
public Measure saveMeasure(Measure measure)
SensorContext
saveMeasure
in interface SensorContext
public Measure saveMeasure(Metric metric, Double value)
SensorContext
saveMeasure
in interface SensorContext
public Measure getMeasure(Resource resource, Metric metric)
SensorContext
getMeasure
in interface SensorContext
public String saveResource(Resource resource)
SensorContext
saveResource
in interface SensorContext
public boolean saveResource(Resource resource, Resource parentReference)
public Resource getResource(Resource resource)
SensorContext
getResource
in interface SensorContext
resource
- the resource reference
public <M> M getMeasures(Resource resource, MeasuresFilter<M> filter)
SensorContext
getMeasures
in interface SensorContext
public Measure saveMeasure(Resource resource, Metric metric, Double value)
SensorContext
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
in interface SensorContext
public Measure saveMeasure(Resource resource, Measure measure)
SensorContext
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
in interface SensorContext
public void saveViolation(Violation violation, boolean force)
SensorContext
saveViolation
in interface SensorContext
force
- allows to force creation of violation even if it was supressed by ViolationFilter
public void saveViolation(Violation violation)
SensorContext
saveViolation
in interface SensorContext
public void saveViolations(Collection<Violation> violations)
SensorContext
saveViolations
in interface SensorContext
public Dependency saveDependency(Dependency dependency)
SensorContext
saveDependency
in interface SensorContext
public Set<Dependency> getDependencies()
getDependencies
in interface SensorContext
public Collection<Dependency> getIncomingDependencies(Resource to)
getIncomingDependencies
in interface SensorContext
public Collection<Dependency> getOutgoingDependencies(Resource from)
getOutgoingDependencies
in interface SensorContext
public void saveSource(Resource reference, String source)
SensorContext
saveSource
in interface SensorContext
public void saveLink(ProjectLink link)
SensorContext
saveLink
in interface SensorContext
public void deleteLink(String key)
SensorContext
deleteLink
in interface SensorContext
public List<Event> getEvents(Resource resource)
getEvents
in interface SensorContext
resource
- set null for project eventspublic Event createEvent(Resource resource, String name, String description, String category, Date date)
SensorContext
createEvent
in interface SensorContext
name
- the event namedescription
- the event descriptioncategory
- the event categorydate
- the event date
public void deleteEvent(Event event)
SensorContext
deleteEvent
in interface SensorContext
event
- the event to delete
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |