org.sonar.api.batch
Interface DecoratorContext


public interface DecoratorContext


Method Summary
 Event createEvent(java.lang.String name, java.lang.String description, java.lang.String category, java.util.Date date)
          Creates an event for a given date
 void deleteEvent(Event event)
          Deletes an event
 java.util.List<DecoratorContext> getChildren()
          Children contexts are read only
 java.util.Collection<Measure> getChildrenMeasures(MeasuresFilter filter)
          Never return null.
 java.util.Collection<Measure> getChildrenMeasures(Metric metric)
           
 java.util.List<Event> getEvents()
           
 Measure getMeasure(Metric metric)
           
<M> M
getMeasures(MeasuresFilter<M> filter)
          Never return null.
 Project getProject()
           
 Resource getResource()
           
 java.util.List<Violation> getViolations()
          Read-only rule failures.
 DecoratorContext saveMeasure(Measure measure)
          Add a measure on the current resource.
 DecoratorContext saveMeasure(Metric metric, java.lang.Double value)
           
 

Method Detail

getProject

Project getProject()

getResource

Resource getResource()

getChildren

java.util.List<DecoratorContext> getChildren()
Children contexts are read only


getMeasure

Measure getMeasure(Metric metric)

getMeasures

<M> M getMeasures(MeasuresFilter<M> filter)
Never return null.


getChildrenMeasures

java.util.Collection<Measure> getChildrenMeasures(MeasuresFilter filter)
Never return null.


getChildrenMeasures

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

saveMeasure

DecoratorContext saveMeasure(Measure measure)
Add a measure on the current resource. It can not be executed from children contexts.

Returns:
the same context

saveMeasure

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

getViolations

java.util.List<Violation> getViolations()
Read-only rule failures.

Returns:
the rule failures for file/classes resources, null for the others

getEvents

java.util.List<Event> getEvents()

createEvent

Event createEvent(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

deleteEvent

void deleteEvent(Event event)
Deletes an event

Parameters:
event - the event to delete


Copyright © 2009 SonarSource SA. All Rights Reserved.