oracle.jdeveloper.audit.analyzer
Interface AuditTaskContext

All Known Implementing Classes:

DefaultAuditTaskContext

public interface AuditTaskContext

Method Summary

<T extends ModelAdapter> 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.
ViolationReport	report(Rule rule, Location location) Reports a rule violation for a construct.
ViolationReport	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.

Method Detail

taskCompleted

void taskCompleted()

Reports that this task has completed or cancelled.

isCancelled

boolean isCancelled()

Gets whether the invoking audit has been cancelled.

getModelAdapter

<T extends ModelAdapter> 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. This method provides the argument required to specify the location of a violation.

report

ViolationReport report(Rule rule,
                       ModelAdapter model,
                       java.lang.Object construct)

Reports a rule violation for a construct. report returns a ViolationReport which allows parameters and other attributes to be added to the violation. See getModelAdapter(Class,java.net.URL,oracle.ide.model.Project,oracle.ide.model.Workspace), and Location.getModel() to obtain a model.

See the class overview for more information.

Parameters:

rule - The rule violated.

model - The model containing the violationg construct.

construct - The violating construct.

report

ViolationReport report(Rule rule,
                       Location location)

Reports a rule violation for a construct. report returns a ViolationReport which allows parameters and other attributes to be added to the violation. See the class overview for more information.

Parameters:

rule - The rule violated.

location - The Location of the the violating construct.