IssueReport
public interface 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)
Deprecated.
Adds a construct in a model as a parameter to the violation.
|
void |
addConstructParameter(java.lang.String name, java.lang.Object construct)
Deprecated.
Adds a construct as a parameter to the violation.
|
void |
addParameter(java.lang.String name, java.lang.Object value)
Deprecated.
Adds a parameter to the violation.
|
void |
hideAllTransforms()
Deprecated.
Hides all the tranforms for this violation.
|
void |
hideTransform(Transform transform)
Deprecated.
Hides a transform for this violation.
|
void |
setDefaultTransform(Transform transform)
Deprecated.
Sets the default transform for this violation.
|
void |
setFocusLocation(Location location)
Deprecated.
Sets the location at the focus of the violation.
|
void |
setFocusLocation(java.lang.Object construct)
Deprecated.
Sets the construct at the focus of the violation.
|
void |
setTransformFocusLocation(Transform transform, Location location)
Deprecated.
Sets the focus location of a transform for this violation.
|
void |
setTransformFocusLocation(Transform transform, java.lang.Object construct)
Deprecated.
Sets the focus location of a transform for this violation.
|
void |
setVariation(java.lang.String name)
Deprecated.
Sets the name of the rule variation which applies to this violation.
|
void |
showTransform(Transform transform)
Deprecated.
Shows a transform for this violation.
|
void addParameter(java.lang.String name, java.lang.Object value)
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));
Parameters:
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);
}
Parameters:
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()
.void setFocusLocation(Location location)
Violation.getLocation()
.void setVariation(java.lang.String name)
name
- The name of the variation: one of the names returned by Rule.variations
.void hideAllTransforms()
void showTransform(Transform transform)
void hideTransform(Transform transform)
void setTransformFocusLocation(Transform transform, java.lang.Object construct)
Violation.getFocusLocation()
.transform
- The transform for which to set the applicability.construct
- The construct in which to focus the transform.void setTransformFocusLocation(Transform transform, Location location)
Violation.getFocusLocation()
.transform
- The transform for which to set the applicability.location
- The location in which to focus the transform.void setDefaultTransform(Transform transform)