org.jboss.as.controller

Class SimpleAttributeDefinitionBuilder

java.lang.Object

org.jboss.as.controller.AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

org.jboss.as.controller.SimpleAttributeDefinitionBuilder

public class SimpleAttributeDefinitionBuilder
extends AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Provides a builder API for creating a SimpleAttributeDefinition.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Field Summary

Fields inherited from class org.jboss.as.controller.AbstractAttributeDefinitionBuilder

accessConstraints, allowExpression, allowNull, alternatives, attributeMarshaller, corrector, defaultValue, deprecated, flags, maxSize, measurementUnit, minSize, name, nullSignficant, parser, requires, resourceOnly, type, validateNull, validator, xmlName

Constructor Summary

Constructors

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)

Method Summary

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.

Methods inherited from class org.jboss.as.controller.AbstractAttributeDefinitionBuilder

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleAttributeDefinitionBuilder

public SimpleAttributeDefinitionBuilder(String attributeName,
                                        org.jboss.dmr.ModelType type)

SimpleAttributeDefinitionBuilder

public SimpleAttributeDefinitionBuilder(String attributeName,
                                        org.jboss.dmr.ModelType type,
                                        boolean allowNull)

SimpleAttributeDefinitionBuilder

public SimpleAttributeDefinitionBuilder(SimpleAttributeDefinition basis)

SimpleAttributeDefinitionBuilder

public SimpleAttributeDefinitionBuilder(String attributeName,
                                        SimpleAttributeDefinition basis)

Method Detail

create

public static SimpleAttributeDefinitionBuilder create(String name,
                                                      org.jboss.dmr.ModelType type)

create

public static SimpleAttributeDefinitionBuilder create(String name,
                                                      org.jboss.dmr.ModelType type,
                                                      boolean allowNull)

create

public static SimpleAttributeDefinitionBuilder create(SimpleAttributeDefinition basis)

create

public static SimpleAttributeDefinitionBuilder create(String name,
                                                      org.jboss.dmr.ModelNode node)

create

public static SimpleAttributeDefinitionBuilder create(String attributeName,
                                                      SimpleAttributeDefinition basis)

build

public SimpleAttributeDefinition build()

Description copied from class: AbstractAttributeDefinitionBuilder

Create the AttributeDefinition

Specified by:

build in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Returns:

the attribute definition. Will not return null

setXmlName

public SimpleAttributeDefinitionBuilder setXmlName(String xmlName)

Description copied from class: AbstractAttributeDefinitionBuilder

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. If not set the default value is the name passed to the builder constructor.

Overrides:

setXmlName in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Parameters:

xmlName - the xml name. null is allowed

Returns:

a builder that can be used to continue building the attribute definition

setDefaultValue

public SimpleAttributeDefinitionBuilder setDefaultValue(org.jboss.dmr.ModelNode defaultValue)

Description copied from class: AbstractAttributeDefinitionBuilder

Sets a default value to use for the attribute if no user-provided value is available.

Overrides:

setDefaultValue in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Parameters:

defaultValue - the default value, or null if no default should be used

Returns:

a builder that can be used to continue building the attribute definition

setValidator

public SimpleAttributeDefinitionBuilder setValidator(ParameterValidator validator)

Description copied from class: AbstractAttributeDefinitionBuilder

Sets the validator that should be used to validate attribute values. The resulting attribute definition will wrap this validator in one that enforces the attribute's allow null and allow expression settings, so the given validator need not be properly configured for those validations.

Overrides:

setValidator in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Parameters:

validator - the validator. null is allowed

Returns:

a builder that can be used to continue building the attribute definition

setFlags

public SimpleAttributeDefinitionBuilder setFlags(AttributeAccess.Flag... flags)

Description copied from class: AbstractAttributeDefinitionBuilder

Sets the special purpose flags that are relevant to the attribute

Overrides:

setFlags in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Parameters:

flags - the flags

Returns:

a builder that can be used to continue building the attribute definition

setAlternatives

public SimpleAttributeDefinitionBuilder setAlternatives(String... alternatives)

Description copied from class: AbstractAttributeDefinitionBuilder

Sets names of alternative attributes that should not be defined if this attribute is defined.

Overrides:

setAlternatives in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Parameters:

alternatives - the attribute names

Returns:

a builder that can be used to continue building the attribute definition

setRequires

public SimpleAttributeDefinitionBuilder setRequires(String... requires)

Description copied from class: AbstractAttributeDefinitionBuilder

Sets names of required attributes that must be defined if this attribute is defined.

Overrides:

setRequires in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Parameters:

requires - the attribute names

Returns:

a builder that can be used to continue building the attribute definition

setMeasurementUnit

public SimpleAttributeDefinitionBuilder setMeasurementUnit(MeasurementUnit unit)

Description copied from class: AbstractAttributeDefinitionBuilder

Sets a measurement unit to describe the unit in which a numeric attribute is expressed.

Overrides:

setMeasurementUnit in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Parameters:

unit - the unit. null is allowed

Returns:

a builder that can be used to continue building the attribute definition

setAllowExpression

public SimpleAttributeDefinitionBuilder setAllowExpression(boolean allowExpression)

Description copied from class: AbstractAttributeDefinitionBuilder

Sets whether the attribute should allow expressions If not set the default value is false.

Overrides:

setAllowExpression in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Parameters:

allowExpression - true if expression values should be allowed

Returns:

a builder that can be used to continue building the attribute definition

setAllowNull

public SimpleAttributeDefinitionBuilder setAllowNull(boolean allowNull)

Description copied from class: AbstractAttributeDefinitionBuilder

Sets whether the attribute should allow undefined values. If not set the default value is the value provided to the builder constructor, or false if no value is provided.

Overrides:

setAllowNull in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Parameters:

allowNull - true if undefined values should be allowed

Returns:

a builder that can be used to continue building the attribute definition

setStorageRuntime

public SimpleAttributeDefinitionBuilder setStorageRuntime()

Description copied from class: AbstractAttributeDefinitionBuilder

Adds the AttributeAccess.Flag#STORAGE_RUNTIME flag and removes any conflicting flag.

Overrides:

setStorageRuntime in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Returns:

a builder that can be used to continue building the attribute definition

setRestartAllServices

public SimpleAttributeDefinitionBuilder setRestartAllServices()

Description copied from class: AbstractAttributeDefinitionBuilder

Adds the AttributeAccess.Flag#RESTART_ALL_SERVICES flag and removes any conflicting flag.

Overrides:

setRestartAllServices in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Returns:

a builder that can be used to continue building the attribute definition

setCorrector

public SimpleAttributeDefinitionBuilder setCorrector(ParameterCorrector corrector)

Description copied from class: AbstractAttributeDefinitionBuilder

Sets a ParameterCorrector to use to adjust any user provided values before validation occurs.

Overrides:

setCorrector in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Parameters:

corrector - the corrector. May be null

Returns:

a builder that can be used to continue building the attribute definition

addFlag

public SimpleAttributeDefinitionBuilder addFlag(AttributeAccess.Flag flag)

Description copied from class: AbstractAttributeDefinitionBuilder

Adds a special purpose flag that is relevant to the attribute

Overrides:

addFlag in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Parameters:

flag - the flag

Returns:

a builder that can be used to continue building the attribute definition

addAlternatives

public SimpleAttributeDefinitionBuilder addAlternatives(String... alternatives)

Description copied from class: AbstractAttributeDefinitionBuilder

Adds names of alternative attributes that should not be defined if this attribute is defined.

Overrides:

addAlternatives in class AbstractAttributeDefinitionBuilder<SimpleAttributeDefinitionBuilder,SimpleAttributeDefinition>

Parameters:

alternatives - the attribute names

Returns:

a builder that can be used to continue building the attribute definition