public class SuppressionScheme extends ExtensionBean
issues
reported through Audit.
Suppression schemes are defined in extension manifests by suppression-scheme-definition elements of an audit-hook element. The definition specifies id, enabled, and transform properties. The id is an immutable property which uniquely identifies the scheme. Audit profiles allow the user to control the enabled property. The definition of a suppression scheme can additionally specify a scheme-specific subclass of this class which defines additional properties of the scheme 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.
The definition defines, implicitly or explicitly, label and description strings for the suppression scheme. See ExtensionBean.labelOrId()
and ExtensionBean.description()
. The object which supplies properties for these strings is the SuppressionScheme instance.
Modifier and Type | Field and Description |
---|---|
static int |
MAX_TRANSFORM_COUNT
The maximum number of transforms allowed by an suppression type.
|
DESCRIPTION_KEY, LABEL_KEY
Constructor and Description |
---|
SuppressionScheme()
Creates an suppression type.
|
Modifier and Type | Method and Description |
---|---|
Category |
category() |
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.
|
SuppressionSchemeDefinition |
definition()
Gets the definition of this bean.
|
Transform[] |
getTransforms()
Gets the transforms which create an suppression for an issue in this scheme.
|
boolean |
isEnabled()
Gets whether this rule is enabled.
|
Parameter[] |
parameters()
Gets the parameters declared by this rule, or an empty array if none.
|
void |
setEnabled(boolean newValue)
Sets whether this scheme is enabled.
|
java.lang.String |
toString() |
addPropertyChangeListener, addPropertyChangeListener, createCopy, description, equals, extensionId, extensionLine, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, formattedString, formattedString, formattedString, hashCode, id, key, label, labelOrId, logError, logError, logWarning, name, propertyDescription, propertyLabel, removePropertyChangeListener, removePropertyChangeListener, setters, string
public static final int MAX_TRANSFORM_COUNT
public SuppressionScheme()
The Audit framework uses this constructor for suppression types declared in an extension manifest, and then injects values for the ExtensionBean.id()
, ExtensionBean.extensionId()
, and transforms
properties.
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 SuppressionSchemeDefinition definition()
definition
in class ExtensionBean
public Category category()
public Parameter[] parameters()
public final boolean isEnabled()
public final void setEnabled(boolean newValue)
public final Transform[] getTransforms()
Transform
s.public java.lang.String toString()
toString
in class java.lang.Object