public class Rule extends ExtensionBean
Issue
or violation
:
Audit originally used the term violation but that does not fit
advisories and incompletes, so issue is now preferred.)
Rules are defined in extension manifests by
The definition defines, implicitly or explicitly, label and
description strings for the rule. See
The definition also defines, implicitly or explicitly, the message string
used to describe an issue. See
For some rules, not all violations of the rule can be described by the
same message format string. A variation name can be set on a violation which
will cause a variation key to be tried before the default tree.Rule
subclass for the rule and
define additional properties which the user will also be allowed to change.
These properties should be bound properties, which in practice means
that the setters should invoke the appropriate ExtensionBean.firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)
method.
ExtensionBean.label()
and
ExtensionBean.description()
. The object which supplies properties for these strings
is the Rule instance.
message(Violation)
. The object which
supplies properties for message strings is a Violation
instance.
Violation
Modifier and Type | Field and Description |
---|---|
static int |
MAX_TRANSFORM_COUNT
The maximum number of transforms allowed by a rule.
|
Constructor and Description |
---|
Rule()
Creates a rule.
|
Modifier and Type | Method and Description |
---|---|
boolean |
assist()
Gets whether this rule is an assist.
|
Category |
category()
Gets the category of this rule.
|
protected void |
copyInternalState(ExtensionBean copy,
java.util.Map<java.lang.String,ExtensionBean> context)
Copies internal subclass state as part of creating a copy of this bean.
|
RuleDefinition |
definition()
Gets the definition of this bean.
|
Transform |
getDefaultTransform()
Gets the default transform for this rule, or null if none.
|
java.lang.String |
getDefaultTransformName()
Gets the name of the default transform of this rule, or null if none.
|
Severity |
getSeverity()
Gets the severity of this rule.
|
StyleCategory |
getStyle()
Gets the style of this rule.
|
Transform[] |
getTransforms()
Gets the transforms which can be applied to violations of this rule.
|
java.lang.String |
htmlMessage(Violation violation)
Gets the formatted HTML violation message for a violation of this rule
using the message template specified by the definition.
|
boolean |
isEnabled()
Gets whether this rule is enabled.
|
boolean |
mandatoryError()
Gets whether this rule is a mandatory error.
|
java.lang.String |
message(Violation violation)
Gets the formatted plain text violation message for a violation of this
rule using the message template specified by the definition.
|
java.lang.String[] |
messages()
Gets the unformatted localized templates for all variations of the
messages which report a violation of this rule.
|
Parameter[] |
parameters()
Gets the parameters declared by this rule, or an empty array if none.
|
void |
setDefaultTransformName(java.lang.String id)
Sets the default transform for this rule by its id.
|
void |
setEnabled(boolean newValue)
Sets whether this rule is enabled.
|
void |
setSeverity(Severity newValue) |
void |
setStyle(StyleCategory newValue)
Sets the style of this rule.
|
java.lang.String |
toString() |
java.util.Collection<java.lang.String> |
variations()
Gets the variations supported by this rule, or an empty array if none.
|
addPropertyChangeListener, addPropertyChangeListener, createCopy, description, equals, extensionId, extensionLine, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, formattedString, formattedString, formattedString, hashCode, id, label, logError, logError, logWarning, name, propertyDescription, propertyLabel, removePropertyChangeListener, removePropertyChangeListener, setters, string
public static final int MAX_TRANSFORM_COUNT
public Rule()
ExtensionBean.id()
,
ExtensionBean.extensionId()
, category
, variations()
,
parameters
transforms
, and defaultTransform
fields.protected void copyInternalState(ExtensionBean copy, java.util.Map<java.lang.String,ExtensionBean> context) throws java.lang.reflect.InvocationTargetException
ExtensionBean
copyInternalState
in class ExtensionBean
copy
- The partially initialized copy.context
- A map which allows subclasses to preserve object identity
when copying a graph of extension beans.java.lang.reflect.InvocationTargetException
ExtensionBean.createCopy(java.util.Map<java.lang.String, oracle.jdeveloper.audit.extension.ExtensionBean>)
public RuleDefinition definition()
definition
in class ExtensionBean
public final boolean mandatoryError()
public final boolean assist()
public Category category()
public Parameter[] parameters()
public java.util.Collection<java.lang.String> variations()
public java.lang.String[] messages()
public java.lang.String message(Violation violation)
violation
- The violation for which to get a message.violation
- The violation for which to get a message.RuleDefinition.message(String)
public java.lang.String htmlMessage(Violation violation)
violation
- The violation for which to get a message.RuleDefinition.htmlMessage(String)
public final Transform getDefaultTransform()
public void setDefaultTransformName(java.lang.String id)
id
- The name of a transform of this rule, or null.public java.lang.String getDefaultTransformName()
public final boolean isEnabled()
public final void setEnabled(boolean newValue)
public final Severity getSeverity()
public final void setSeverity(Severity newValue)
public final StyleCategory getStyle()
public final void setStyle(StyleCategory newValue)
newValue
- The new style of this rule.public final Transform[] getTransforms()
Transform
s.getDefaultTransform()
public java.lang.String toString()
toString
in class java.lang.Object