public class RuleDefinition extends BeanDefinition implements HasCategory, HasTransformBindings
Type | Property and Description |
---|---|
boolean |
hasEnabled |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
HTML_MESSAGE_KEY
The key for the message text of a rule.
|
static java.lang.String |
MESSAGE_KEY
The key for the message text of a rule.
|
DESCRIPTION_KEY, LABEL_KEY
Constructor and Description |
---|
RuleDefinition(java.lang.String id,
CategoryDefinition category,
ExtensionBundle bundle,
DefinitionContext context) |
Modifier and Type | Method and Description |
---|---|
void |
addTransformBinding(TransformBinding binding) |
CategoryDefinition |
getCategory() |
java.util.Collection<ParameterDefinition> |
getParameters() |
Severity |
getSeverity() |
java.util.Collection<java.lang.String> |
getSuppressionIds() |
java.util.Collection<TransformBinding> |
getTransformBindings() |
java.util.Collection<java.lang.String> |
getVariations() |
boolean |
hasEnabledProperty() |
java.lang.String |
htmlMessage(java.lang.String variation)
Gets the localized HTML violation message for a violation of this rule
from its localizer using this key for a default (null) variation:
|
boolean |
isAssist() |
boolean |
isMandatoryError() |
java.lang.String |
message(java.lang.String variation)
Gets the localized violation message for a violation of this rule from its
localizer using this key for a default (null) variation:
|
java.lang.String[] |
messages() |
void |
setCategory(CategoryDefinition category) |
void |
setMandatoryError(boolean mandatoryError) |
void |
setParameters(java.util.Collection<ParameterDefinition> parameters) |
void |
setSeverity(Severity severity) |
void |
setSuppressionIds(java.util.Collection<java.lang.String> suppressionIds) |
void |
setVariations(java.util.Collection<java.lang.String> variations) |
getImplementationClass, getValue, getValues, isEnabledByDefault, setImplementationClass, setValues
addDeprecatedId, bind, description, equals, formattedString, formattedString, getDeprecatedIds, getElementName, getExtensionBundle, getId, getName, getStrings, hashCode, label, missingLabel, missingString, propertyDescription, propertyLabel, propertyString, setStrings, string, toString
getColumnNumber, getContext, getExtensionId, getLineNumber, getPublicId, getSystemId, isExtensionLoaded, log, log
hasEnabledProperty
in class BeanDefinition
public static final java.lang.String MESSAGE_KEY
public static final java.lang.String HTML_MESSAGE_KEY
public RuleDefinition(java.lang.String id, CategoryDefinition category, ExtensionBundle bundle, DefinitionContext context)
public void setCategory(CategoryDefinition category)
setCategory
in interface HasCategory
public CategoryDefinition getCategory()
getCategory
in interface HasCategory
public boolean hasEnabledProperty()
hasEnabledProperty
in class BeanDefinition
public Severity getSeverity()
public boolean isAssist()
public void setSeverity(Severity severity)
public java.util.Collection<ParameterDefinition> getParameters()
public void setParameters(java.util.Collection<ParameterDefinition> parameters)
public java.util.Collection<java.lang.String> getVariations()
public void setVariations(java.util.Collection<java.lang.String> variations)
public java.util.Collection<TransformBinding> getTransformBindings()
getTransformBindings
in interface HasTransformBindings
public void addTransformBinding(TransformBinding binding)
addTransformBinding
in interface HasTransformBindings
public boolean isMandatoryError()
public void setMandatoryError(boolean mandatoryError)
public java.util.Collection<java.lang.String> getSuppressionIds()
public void setSuppressionIds(java.util.Collection<java.lang.String> suppressionIds)
public java.lang.String message(java.lang.String variation)
"rule." + getName() + ".message"
and the first defined of these keys for a named variation:
"rule." + getName() + "." + violation.getVariation() + ".message"
"rule." + getName() + ".message"
public java.lang.String htmlMessage(java.lang.String variation)
"rule." + getName() + ".html-message"
and the first defined of these keys for a named variation:
"rule." + getName() + "." + violation.getVariation() + ".html-message"
"rule." + getName() + ".message"
fpublic java.lang.String[] messages()