public class SimpleAttributeDefinitionBuilder extends AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
SimpleAttributeDefinition
.accessConstraints, allowExpression, allowNull, alternatives, attributeMarshaller, corrector, defaultValue, deprecated, flags, maxSize, measurementUnit, minSize, name, nullSignficant, parser, requires, resourceOnly, type, validateNull, validator, xmlName
Constructor and Description |
---|
SimpleAttributeDefinitionBuilder(SimpleAttributeDefinition basis) |
SimpleAttributeDefinitionBuilder(String attributeName,
org.jboss.dmr.ModelType type) |
SimpleAttributeDefinitionBuilder(String attributeName,
org.jboss.dmr.ModelType type,
boolean allowNull) |
SimpleAttributeDefinitionBuilder(String attributeName,
SimpleAttributeDefinition basis) |
Modifier and Type | Method and Description |
---|---|
SimpleAttributeDefinitionBuilder |
addAlternatives(String... alternatives)
Adds
names of alternative attributes that should not
be defined if this attribute is defined. |
SimpleAttributeDefinitionBuilder |
addFlag(AttributeAccess.Flag flag)
Adds a
special purpose flag that is relevant to the attribute |
SimpleAttributeDefinition |
build()
Create the
AttributeDefinition |
static SimpleAttributeDefinitionBuilder |
create(SimpleAttributeDefinition basis) |
static SimpleAttributeDefinitionBuilder |
create(String name,
org.jboss.dmr.ModelNode node) |
static SimpleAttributeDefinitionBuilder |
create(String name,
org.jboss.dmr.ModelType type) |
static SimpleAttributeDefinitionBuilder |
create(String name,
org.jboss.dmr.ModelType type,
boolean allowNull) |
static SimpleAttributeDefinitionBuilder |
create(String attributeName,
SimpleAttributeDefinition basis) |
SimpleAttributeDefinitionBuilder |
setAllowExpression(boolean allowExpression)
Sets whether the attribute should
allow expressions
If not set the default value is false . |
SimpleAttributeDefinitionBuilder |
setAllowNull(boolean allowNull)
Sets whether the attribute should
allow undefined values . |
SimpleAttributeDefinitionBuilder |
setAlternatives(String... alternatives)
Sets
names of alternative attributes that should not
be defined if this attribute is defined. |
SimpleAttributeDefinitionBuilder |
setCorrector(ParameterCorrector corrector)
Sets a
ParameterCorrector to use to adjust any user provided values
before validation
occurs. |
SimpleAttributeDefinitionBuilder |
setDefaultValue(org.jboss.dmr.ModelNode defaultValue)
Sets a
default value to use for the attribute if no
user-provided value is available. |
SimpleAttributeDefinitionBuilder |
setFlags(AttributeAccess.Flag... flags)
Sets the
special purpose flags that are relevant to the attribute |
SimpleAttributeDefinitionBuilder |
setMeasurementUnit(MeasurementUnit unit)
Sets a
measurement unit to describe the unit in
which a numeric attribute is expressed. |
SimpleAttributeDefinitionBuilder |
setRequires(String... requires)
Sets
names of required attributes that must
be defined if this attribute is defined. |
SimpleAttributeDefinitionBuilder |
setRestartAllServices()
Adds the
AttributeAccess.Flag#RESTART_ALL_SERVICES flag and removes any conflicting flag. |
SimpleAttributeDefinitionBuilder |
setStorageRuntime()
Adds the
AttributeAccess.Flag#STORAGE_RUNTIME flag and removes any conflicting flag. |
SimpleAttributeDefinitionBuilder |
setValidator(ParameterValidator validator)
Sets the validator that should be used to validate attribute values.
|
SimpleAttributeDefinitionBuilder |
setXmlName(String xmlName)
Sets the
xml name for the attribute, which is only needed
if the name used for the attribute is different from its ordinary
name in the model . |
addAccessConstraint, getAccessConstraints, getAlternatives, getAttributeMarshaller, getCorrector, getDefaultValue, getDeprecated, getFlags, getMaxSize, getMeasurementUnit, getMinSize, getName, getNullSignficant, getParser, getRequires, getType, getValidator, getXmlName, isAllowExpression, isAllowNull, isFlagPresent, isResourceOnly, isValidateNull, removeFlag, setAccessConstraints, setAttributeMarshaller, setAttributeParser, setDeprecated, setMaxSize, setMinSize, setNullSignficant, setResourceOnly, setRestartJVM, setType, setValidateNull
public SimpleAttributeDefinitionBuilder(String attributeName, org.jboss.dmr.ModelType type)
public SimpleAttributeDefinitionBuilder(String attributeName, org.jboss.dmr.ModelType type, boolean allowNull)
public SimpleAttributeDefinitionBuilder(SimpleAttributeDefinition basis)
public SimpleAttributeDefinitionBuilder(String attributeName, SimpleAttributeDefinition basis)
public static SimpleAttributeDefinitionBuilder create(String name, org.jboss.dmr.ModelType type)
public static SimpleAttributeDefinitionBuilder create(String name, org.jboss.dmr.ModelType type, boolean allowNull)
public static SimpleAttributeDefinitionBuilder create(SimpleAttributeDefinition basis)
public static SimpleAttributeDefinitionBuilder create(String name, org.jboss.dmr.ModelNode node)
public static SimpleAttributeDefinitionBuilder create(String attributeName, SimpleAttributeDefinition basis)
public SimpleAttributeDefinition build()
AbstractAttributeDefinitionBuilder
AttributeDefinition
build
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
null
public SimpleAttributeDefinitionBuilder setXmlName(String xmlName)
AbstractAttributeDefinitionBuilder
xml name
for the attribute, which is only needed
if the name used for the attribute is different from its ordinary
name in the model
. If not set the default value is the name
passed to the builder constructor.setXmlName
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
xmlName
- the xml name. null
is allowedpublic SimpleAttributeDefinitionBuilder setDefaultValue(org.jboss.dmr.ModelNode defaultValue)
AbstractAttributeDefinitionBuilder
default value
to use for the attribute if no
user-provided value is available.setDefaultValue
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
defaultValue
- the default value, or null
if no default should be usedpublic SimpleAttributeDefinitionBuilder setValidator(ParameterValidator validator)
AbstractAttributeDefinitionBuilder
allow null
and
allow expression
settings, so the given validator
need not be properly configured for those validations.setValidator
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
validator
- the validator. null
is allowedpublic SimpleAttributeDefinitionBuilder setFlags(AttributeAccess.Flag... flags)
AbstractAttributeDefinitionBuilder
special purpose flags
that are relevant to the attributesetFlags
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
flags
- the flagspublic SimpleAttributeDefinitionBuilder setAlternatives(String... alternatives)
AbstractAttributeDefinitionBuilder
names of alternative attributes
that should not
be defined if this attribute is defined.setAlternatives
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
alternatives
- the attribute namespublic SimpleAttributeDefinitionBuilder setRequires(String... requires)
AbstractAttributeDefinitionBuilder
names of required attributes
that must
be defined if this attribute is defined.setRequires
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
requires
- the attribute namespublic SimpleAttributeDefinitionBuilder setMeasurementUnit(MeasurementUnit unit)
AbstractAttributeDefinitionBuilder
measurement unit
to describe the unit in
which a numeric attribute is expressed.setMeasurementUnit
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
unit
- the unit. null
is allowedpublic SimpleAttributeDefinitionBuilder setAllowExpression(boolean allowExpression)
AbstractAttributeDefinitionBuilder
allow expressions
If not set the default value is false
.setAllowExpression
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
allowExpression
- true
if expression values should be allowedpublic SimpleAttributeDefinitionBuilder setAllowNull(boolean allowNull)
AbstractAttributeDefinitionBuilder
allow undefined values
.
If not set the default value is the value provided to the builder constructor, or false
if no value is provided.setAllowNull
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
allowNull
- true
if undefined values should be allowedpublic SimpleAttributeDefinitionBuilder setStorageRuntime()
AbstractAttributeDefinitionBuilder
AttributeAccess.Flag#STORAGE_RUNTIME
flag and removes any conflicting flag.setStorageRuntime
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
public SimpleAttributeDefinitionBuilder setRestartAllServices()
AbstractAttributeDefinitionBuilder
AttributeAccess.Flag#RESTART_ALL_SERVICES
flag and removes any conflicting flag.setRestartAllServices
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
public SimpleAttributeDefinitionBuilder setCorrector(ParameterCorrector corrector)
AbstractAttributeDefinitionBuilder
ParameterCorrector
to use to adjust any user provided values
before validation
occurs.setCorrector
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
corrector
- the corrector. May be null
public SimpleAttributeDefinitionBuilder addFlag(AttributeAccess.Flag flag)
AbstractAttributeDefinitionBuilder
special purpose flag
that is relevant to the attributeaddFlag
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
flag
- the flagpublic SimpleAttributeDefinitionBuilder addAlternatives(String... alternatives)
AbstractAttributeDefinitionBuilder
names of alternative attributes
that should not
be defined if this attribute is defined.addAlternatives
in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>
alternatives
- the attribute namesCopyright © 2015 JBoss by Red Hat. All rights reserved.