public interface IssueReport extends ViolationReport
AuditContext
only allow a client
to specify the rule and location properties of a violation. To allow a
client to specify additional properties--variation, parameters, transforms,
recommended transforms, focus location, and related location--the
AuditContext
report methods return an instance of this interface
to the client.Modifier and Type | Method and Description |
---|---|
void |
addConstructParameter(java.lang.String name,
ModelAdapter model,
java.lang.Object construct)
Adds a construct in a model as a parameter to the issue.
|
void |
addConstructParameter(java.lang.String name,
java.lang.Object construct)
Adds a construct as a parameter to the issue.
|
void |
addParameter(java.lang.String name,
java.lang.Object value)
Adds a parameter to the issue.
|
void |
hideAllTransforms()
Hides all the transforms for this issue.
|
void |
hideTransform(Transform transform)
Hides a transform for this issue.
|
void |
setDefaultTransform(Transform transform)
Sets the default transform for this issue.
|
void |
setFocusLocation(Location location)
Sets the location at the focus of the issue.
|
void |
setFocusLocation(java.lang.Object construct)
Sets the construct at the focus of the issue.
|
void |
setVariation(java.lang.String name)
Sets the name of the rule variation which applies to this issue.
|
void |
showTransform(Transform transform)
Shows a transform for this violation.
|
void addParameter(java.lang.String name, java.lang.Object value)
addParameter
in interface ViolationReport
name
- the name of the parametervalue
- the value of the parameterViolationReport.addConstructParameter(java.lang.String, java.lang.Object)
void addConstructParameter(java.lang.String name, java.lang.Object construct)
Location
s to track constructs over time. This method
is convenience method for:
addParameter(name, context.getModel().getLocation(construct));
addConstructParameter
in interface ViolationReport
name
- the name of the parameter.construct
- the construct that is the intended parameter value.addParameter(java.lang.String, java.lang.Object)
void addConstructParameter(java.lang.String name, ModelAdapter model, java.lang.Object construct)
Location
s to track constructs over
time. This method is convenience method for:
model.beginRead(true);
try
{
addParameter(name, model.getLocation(construct));
}
finally
{
model.endRead(true);
}
addConstructParameter
in interface ViolationReport
name
- the name of the parameter.model
- the model containing the constructconstruct
- the construct that is the intended parameter value.addParameter(java.lang.String, java.lang.Object)
void setFocusLocation(java.lang.Object construct)
Violation.getLocation()
.setFocusLocation
in interface ViolationReport
void setFocusLocation(Location location)
Violation.getLocation()
.setFocusLocation
in interface ViolationReport
void setVariation(java.lang.String name)
setVariation
in interface ViolationReport
name
- The name of the variation: one of the names returned by
Rule.variations()
.void hideAllTransforms()
hideAllTransforms
in interface ViolationReport
void showTransform(Transform transform)
showTransform
in interface ViolationReport
void hideTransform(Transform transform)
hideTransform
in interface ViolationReport
void setDefaultTransform(Transform transform)
setDefaultTransform
in interface ViolationReport