oracle.jdeveloper.audit.service

Interface Violation

All Superinterfaces:

Issue

public interface Violation
extends Issue

A violation of an Audit rule.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getConstruct() Gets the model object associated with this issue, if any.
Transform	getDefaultTransform() Gets the default transform of this violation, or null if none.
Location	getFocusLocation() Gets the focus location of the violation, or null if none.
Location	getLocation() Gets the location of the violating construct.
int	getParameterCount() Gets the number of parameters of this violation.
java.lang.String	getParameterName(int index) Gets the name of a parameter of this violation.
java.lang.Object	getParameterValue(int index) Gets the value of a parameter of this violation.
java.lang.Object	getParameterValue(java.lang.String name) Gets the value of a parameter of this violation by name.
Rule	getRule() Gets the rule violated by this violation.
int	getSerialNumber() Gets the serial number of this violation.
Suppression	getSuppression(int index) Gets a suppression matching this violation.
int	getSuppressionCount() Gets the number of suppressions matching this violation.
Transform	getTransform(int index) Gets a transform of this violation.
int	getTransformCount() Gets the number of transforms of this violation.
java.lang.String	getVariation() Gets the variation in the rule violated, or null if the default.

Methods inherited from interface oracle.javatools.status.Issue

getHtmlMessage, getLength, getMessage, getOffset, getSeverity, getTransforms, hasTransforms

Method Detail

getRule

Rule getRule()

Gets the rule violated by this violation.

getVariation

java.lang.String getVariation()

Gets the variation in the rule violated, or null if the default.

getLocation

Location getLocation()

Gets the location of the violating construct.

getFocusLocation

Location getFocusLocation()

Gets the focus location of the violation, or null if none.

getParameterCount

int getParameterCount()

Gets the number of parameters of this violation.

getParameterName

java.lang.String getParameterName(int index)

Gets the name of a parameter of this violation.

Parameters:

index - The index of the parameter.

getParameterValue

java.lang.Object getParameterValue(int index)

Gets the value of a parameter of this violation.

Parameters:

index - The index of the parameter.

getParameterValue

java.lang.Object getParameterValue(java.lang.String name)

Gets the value of a parameter of this violation by name.

getTransformCount

int getTransformCount()

Gets the number of transforms of this violation.

getTransform

Transform getTransform(int index)

Gets a transform of this violation.

Parameters:

index - The index of the transform.

getDefaultTransform

Transform getDefaultTransform()

Gets the default transform of this violation, or null if none.

getSuppressionCount

int getSuppressionCount()

Gets the number of suppressions matching this violation.

getSuppression

Suppression getSuppression(int index)

Gets a suppression matching this violation.

Parameters:

index - The index of the suppression.

getSerialNumber

int getSerialNumber()

Gets the serial number of this violation.

getConstruct

java.lang.Object getConstruct()

Gets the model object associated with this issue, if any.

Some implementations of this method require one kind or another of locking, but this interface does not expose any methods for that so it is not practical to ask clients to do the locking. Therefore, the implementations of this method must do any required locking. In practice, this mostly means implementations that extend the Audit framework's Violation interface.

Even though the implementations do not require client locking, the source models for most Node types actually do expect clients to hold a lock, usually the Node/TextBuffer lock, while holding constructs of the source model. Consequently, taking the appropriate lock before calling this method is recommended.

A typical implementation will get the construct using the Location and should look something like this:

 public Object getConstruct()
 {
   Location location = getLocation();
   ModelAdapter model = location.getModel();
   boolean locked = false;
   try
   {
     model.beginRead();
     locked = true;
     return model.getConstruct(location);
   }
   catch (ModelAccessError e)
   {
     return null;
   }
   catch (InterruptedException e)
   {
     Thread.currentThread().interrupt();
     return null;
   }
   finally
   {
     if (locked) model.endRead();
   }
 }
 

Specified by:

getConstruct in interface Issue