public class DefaultAuditTaskContext extends java.lang.Object implements AuditTaskContext
Constructor and Description |
---|
DefaultAuditTaskContext(DefaultAuditor auditor,
Analyzer analyzer,
ModelFactory factory,
java.util.concurrent.BlockingQueue<Violation> queue) |
Modifier and Type | Method and Description |
---|---|
<T extends ModelAdapter> |
getModel(java.lang.Class<T> type,
java.net.URL url,
Project project,
Workspace workspace)
Gets the adapter for the model corresponding to a workspace, project, and
url.
|
<T extends ModelAdapter> |
getModelAdapter(java.lang.Class<T> type,
java.net.URL url,
Project project,
Workspace workspace)
Gets the adapter for the model corresponding to a workspace, project, and
url.
|
boolean |
isCancelled()
Gets whether the invoking audit has been cancelled.
|
IssueReport |
report(Rule rule,
Location location)
Reports a rule violation for a construct.
|
IssueReport |
report(Rule rule,
ModelAdapter model,
java.lang.Object construct)
Reports a rule violation for a construct.
|
void |
taskCompleted()
Reports that this task has completed or cancelled.
|
public DefaultAuditTaskContext(DefaultAuditor auditor, Analyzer analyzer, ModelFactory factory, java.util.concurrent.BlockingQueue<Violation> queue)
public boolean isCancelled()
AuditTaskContext
isCancelled
in interface AuditTaskContext
public <T extends ModelAdapter> ModelAdapter getModel(java.lang.Class<T> type, java.net.URL url, Project project, Workspace workspace)
AuditTaskContext
getModel
in interface AuditTaskContext
public <T extends ModelAdapter> ModelAdapter getModelAdapter(java.lang.Class<T> type, java.net.URL url, Project project, Workspace workspace)
AuditTaskContext
getModelAdapter
in interface AuditTaskContext
public IssueReport report(Rule rule, Location location)
AuditTaskContext
report
returns a IssueReport
which allows parameters and other
attributes to be added to the violation. See the
class overview
for more information.report
in interface AuditTaskContext
rule
- The rule violated.location
- The Location
of the violating construct.public IssueReport report(Rule rule, ModelAdapter model, java.lang.Object construct)
AuditTaskContext
report
returns a
IssueReport
which allows parameters and other attributes to be
added to the violation. See AuditTaskContext.getModel(Class,URL,Project,Workspace)
,
and Location.getModel()
to obtain a model.
See the class overview
for more information.report
in interface AuditTaskContext
rule
- The rule violated.model
- The model containing the violating construct.construct
- The violating construct.public void taskCompleted()
AuditTaskContext
taskCompleted
in interface AuditTaskContext