org.jboss.as.controller

Class AbstractAttributeDefinitionBuilder<BUILDER extends AbstractAttributeDefinitionBuilder,ATTRIBUTE extends AttributeDefinition>

java.lang.Object

org.jboss.as.controller.AbstractAttributeDefinitionBuilder<BUILDER,ATTRIBUTE>

Type Parameters:

BUILDER - the specific subclass type returned by the various builder API methods

ATTRIBUTE - the type of AttributeDefinition produced by the build() method

Direct Known Subclasses:

ListAttributeDefinition.Builder, MapAttributeDefinition.Builder, ObjectTypeAttributeDefinition.Builder, SimpleAttributeDefinitionBuilder

public abstract class AbstractAttributeDefinitionBuilder<BUILDER extends AbstractAttributeDefinitionBuilder,ATTRIBUTE extends AttributeDefinition>
extends Object

Provides a builder API for creating an AttributeDefinition.

Author:

Tomaz Cerar

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessConstraintDefinition[]	accessConstraints
protected org.jboss.dmr.ModelNode[]	allowedValues
protected boolean	allowExpression
protected boolean	allowNull
protected String[]	alternatives
protected String	attributeGroup
protected AttributeMarshaller	attributeMarshaller
protected ParameterCorrector	corrector
protected org.jboss.dmr.ModelNode	defaultValue
protected DeprecationData	deprecated
protected AttributeAccess.Flag[]	flags
protected int	maxSize
protected MeasurementUnit	measurementUnit
protected int	minSize
protected String	name
protected Boolean	nullSignificant
protected AttributeParser	parser
protected String[]	requires
protected boolean	resourceOnly
protected org.jboss.dmr.ModelType	type
protected boolean	validateNull
protected ParameterValidator	validator
protected String	xmlName

Constructor Summary

Constructors

Constructor and Description
AbstractAttributeDefinitionBuilder(AttributeDefinition basis) Creates a builder populated with the values of an existing attribute definition.
AbstractAttributeDefinitionBuilder(String attributeName, AttributeDefinition basis) Creates a builder populated with the values of an existing attribute definition, with an optional change of the attribute's name.
AbstractAttributeDefinitionBuilder(String attributeName, org.jboss.dmr.ModelType type) Creates a builder for an attribute with the give name and type.
AbstractAttributeDefinitionBuilder(String attributeName, org.jboss.dmr.ModelType type, boolean allowNull) Creates a builder for an attribute with the give name and type and nullability setting.

Method Summary

Modifier and Type	Method and Description
BUILDER	addAccessConstraint(AccessConstraintDefinition accessConstraint) Adds an access constraint to the set used with the attribute
BUILDER	addAlternatives(String... alternatives) Adds names of alternative attributes that should not be defined if this attribute is defined.
BUILDER	addFlag(AttributeAccess.Flag flag) Adds a special purpose flag that is relevant to the attribute
abstract ATTRIBUTE	build() Create the AttributeDefinition
AccessConstraintDefinition[]	getAccessConstraints()
org.jboss.dmr.ModelNode[]	getAllowedValues()
String[]	getAlternatives()
String	getAttributeGroup()
AttributeMarshaller	getAttributeMarshaller()
ParameterCorrector	getCorrector()
org.jboss.dmr.ModelNode	getDefaultValue()
DeprecationData	getDeprecated()
AttributeAccess.Flag[]	getFlags()
int	getMaxSize()
MeasurementUnit	getMeasurementUnit()
int	getMinSize()
String	getName()
Boolean	getNullSignficant() Deprecated. Use getNullSignificant().
Boolean	getNullSignificant()
AttributeParser	getParser()
String[]	getRequires()
org.jboss.dmr.ModelType	getType()
ParameterValidator	getValidator()
String	getXmlName()
boolean	isAllowExpression()
boolean	isAllowNull()
protected boolean	isFlagPresent(AttributeAccess.Flag flag) Checks if a special purpose flag has been recorded as relevant to the attribute
boolean	isResourceOnly()
boolean	isValidateNull()
BUILDER	removeFlag(AttributeAccess.Flag flag) Removes a special purpose flag from the set of those relevant to the attribute
BUILDER	setAccessConstraints(AccessConstraintDefinition... accessConstraints) Sets access constraints to use with the attribute
BUILDER	setAllowedValues(int... allowedValues) Sets allowed values for attribute
BUILDER	setAllowedValues(org.jboss.dmr.ModelNode... allowedValues) Sets allowed values for attribute
BUILDER	setAllowedValues(String... allowedValues) Sets allowed values for attribute
BUILDER	setAllowExpression(boolean allowExpression) Sets whether the attribute should allow expressions If not set the default value is false.
BUILDER	setAllowNull(boolean allowNull) Sets whether the attribute should allow undefined values.
BUILDER	setAlternatives(String... alternatives) Sets names of alternative attributes that should not be defined if this attribute is defined.
BUILDER	setAttributeGroup(String attributeGroup) Sets the name of the attribute group with which this attribute is associated.
BUILDER	setAttributeMarshaller(AttributeMarshaller marshaller) Sets a custom AttributeMarshaller to use for marshalling the attribute to xml.
BUILDER	setAttributeParser(AttributeParser parser) Sets a custom AttributeParser to use for parsing attribute from xml.
BUILDER	setCorrector(ParameterCorrector corrector) Sets a ParameterCorrector to use to adjust any user provided values before validation occurs.
BUILDER	setDefaultValue(org.jboss.dmr.ModelNode defaultValue) Sets a default value to use for the attribute if no user-provided value is available.
BUILDER	setDeprecated(ModelVersion since) Marks the attribute as deprecated since the given API version.
BUILDER	setFlags(AttributeAccess.Flag... flags) Sets the special purpose flags that are relevant to the attribute
BUILDER	setMaxSize(int maxSize) Sets a maximum size for a collection-type attribute.
BUILDER	setMeasurementUnit(MeasurementUnit unit) Sets a measurement unit to describe the unit in which a numeric attribute is expressed.
BUILDER	setMinSize(int minSize) Sets a minimum size description for a collection-type attribute.
BUILDER	setName(String name) Sets the name for the attribute, which is only needed if the attribute was created from an existing SimpleAttributeDefinition using SimpleAttributeDefinitionBuilder.create(org.jboss.as.controller.SimpleAttributeDefinition) method.
BUILDER	setNullSignficant(boolean nullSignficant) Deprecated. Use setNullSignificant(boolean).
BUILDER	setNullSignificant(boolean nullSignificant) Sets whether an access control check is required to implicitly set an attribute to undefined in a resource "add" operation.
BUILDER	setRequires(String... requires) Sets names of required attributes that must be defined if this attribute is defined.
BUILDER	setResourceOnly() Marks an attribute as only relevant to a resource, and not a valid parameter to an "add" operation that creates that resource.
BUILDER	setRestartAllServices() Adds the AttributeAccess.Flag#RESTART_ALL_SERVICES flag and removes any conflicting flag.
BUILDER	setRestartJVM() Adds the AttributeAccess.Flag#RESTART_JVM flag and removes any conflicting flag.
BUILDER	setStorageRuntime() Adds the AttributeAccess.Flag#STORAGE_RUNTIME flag and removes any conflicting flag.
BUILDER	setType(org.jboss.dmr.ModelType type) Sets the type for the attribute.
BUILDER	setValidateNull(boolean validateNull) Sets whether the attribute definition should check for undefined values if null is not allowed in addition to any validation provided by any configured validator.
BUILDER	setValidator(ParameterValidator validator) Sets the validator that should be used to validate attribute values.
BUILDER	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 java.lang.Object

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

Field Detail

name

protected String name

type

protected org.jboss.dmr.ModelType type

xmlName

protected String xmlName

allowNull

protected boolean allowNull

allowExpression

protected boolean allowExpression

defaultValue

protected org.jboss.dmr.ModelNode defaultValue

measurementUnit

protected MeasurementUnit measurementUnit

alternatives

protected String[] alternatives

requires

protected String[] requires

allowedValues

protected org.jboss.dmr.ModelNode[] allowedValues

corrector

protected ParameterCorrector corrector

validator

protected ParameterValidator validator

validateNull

protected boolean validateNull

minSize

protected int minSize

maxSize

protected int maxSize

flags

protected AttributeAccess.Flag[] flags

attributeMarshaller

protected AttributeMarshaller attributeMarshaller

resourceOnly

protected boolean resourceOnly

deprecated

protected DeprecationData deprecated

accessConstraints

protected AccessConstraintDefinition[] accessConstraints

nullSignificant

protected Boolean nullSignificant

parser

protected AttributeParser parser

attributeGroup

protected String attributeGroup

Constructor Detail

AbstractAttributeDefinitionBuilder

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

Creates a builder for an attribute with the give name and type. Equivalent to AbstractAttributeDefinitionBuilder(attributeName, type, false

Parameters:

attributeName - the name of the attribute. Cannot be null

type - the type of the attribute. Cannot be null

AbstractAttributeDefinitionBuilder

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

Creates a builder for an attribute with the give name and type and nullability setting.

Parameters:

attributeName - the name of the attribute. Cannot be null

type - the type of the attribute. Cannot be null

allowNull - true if the allows undefined values

AbstractAttributeDefinitionBuilder

public AbstractAttributeDefinitionBuilder(AttributeDefinition basis)

Creates a builder populated with the values of an existing attribute definition.

Parameters:

basis - the existing attribute definition. Cannot be null

AbstractAttributeDefinitionBuilder

public AbstractAttributeDefinitionBuilder(String attributeName,
                                          AttributeDefinition basis)

Creates a builder populated with the values of an existing attribute definition, with an optional change of the attribute's name.

Parameters:

attributeName - the name of the attribute, or null if the name from basis should be used

basis - the existing attribute definition. Cannot be null

Method Detail

build

public abstract ATTRIBUTE build()

Create the AttributeDefinition

Returns:

the attribute definition. Will not return null

setName

public BUILDER setName(String name)

Sets the name for the attribute, which is only needed if the attribute was created from an existing SimpleAttributeDefinition using SimpleAttributeDefinitionBuilder.create(org.jboss.as.controller.SimpleAttributeDefinition) method.

Parameters:

name - the attribute's name. null is not allowed

Returns:

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

setXmlName

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

Parameters:

xmlName - the xml name. null is allowed

Returns:

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

setType

public BUILDER setType(org.jboss.dmr.ModelType type)

Sets the type for the attribute.

Parameters:

type - the type. null is not allowed

Returns:

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

setAllowNull

public BUILDER setAllowNull(boolean allowNull)

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.

Parameters:

allowNull - true if undefined values should be allowed

Returns:

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

setAllowExpression

public BUILDER setAllowExpression(boolean allowExpression)

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

Parameters:

allowExpression - true if expression values should be allowed

Returns:

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

setDefaultValue

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

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

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

setMeasurementUnit

public BUILDER setMeasurementUnit(MeasurementUnit unit)

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

Parameters:

unit - the unit. null is allowed

Returns:

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

setCorrector

public BUILDER setCorrector(ParameterCorrector corrector)

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

Parameters:

corrector - the corrector. May be null

Returns:

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

setValidator

public BUILDER setValidator(ParameterValidator validator)

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.

Parameters:

validator - the validator. null is allowed

Returns:

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

setValidateNull

public BUILDER setValidateNull(boolean validateNull)

Sets whether the attribute definition should check for undefined values if null is not allowed in addition to any validation provided by any configured validator. The default if not set is true. The use case for setting this to false would be to ignore undefined values in the basic validation performed by the AttributeDefinition and instead let operation handlers validate using more complex logic (e.g. checking for alternatives.

Parameters:

validateNull - true if additional validation should be performed; false otherwise

Returns:

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

setAlternatives

public BUILDER setAlternatives(String... alternatives)

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

Parameters:

alternatives - the attribute names

Returns:

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

addAlternatives

public BUILDER addAlternatives(String... alternatives)

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

Parameters:

alternatives - the attribute names

Returns:

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

setRequires

public BUILDER setRequires(String... requires)

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

Parameters:

requires - the attribute names

Returns:

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

setFlags

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

Sets the special purpose flags that are relevant to the attribute

Parameters:

flags - the flags

Returns:

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

addFlag

public BUILDER addFlag(AttributeAccess.Flag flag)

Adds a special purpose flag that is relevant to the attribute

Parameters:

flag - the flag

Returns:

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

removeFlag

public BUILDER removeFlag(AttributeAccess.Flag flag)

Removes a special purpose flag from the set of those relevant to the attribute

Parameters:

flag - the flag

Returns:

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

isFlagPresent

protected boolean isFlagPresent(AttributeAccess.Flag flag)

Checks if a special purpose flag has been recorded as relevant to the attribute

Parameters:

flag - the flag

Returns:

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

setStorageRuntime

public BUILDER setStorageRuntime()

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

Returns:

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

setRestartAllServices

public BUILDER setRestartAllServices()

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

Returns:

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

setRestartJVM

public BUILDER setRestartJVM()

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

Returns:

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

setMaxSize

public BUILDER setMaxSize(int maxSize)

Sets a maximum size for a collection-type attribute. TODO this is not used by SimpleAttributeDefinition even though intuitively a user may expect it would be used.

Parameters:

maxSize - the maximum size

Returns:

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

setMinSize

public BUILDER setMinSize(int minSize)

Sets a minimum size description for a collection-type attribute. TODO this is not used by SimpleAttributeDefinition even though intuitively a user may expect it would be used.

Parameters:

minSize - the minimum size

Returns:

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

setAttributeMarshaller

public BUILDER setAttributeMarshaller(AttributeMarshaller marshaller)

Sets a custom AttributeMarshaller to use for marshalling the attribute to xml. If not set, a DefaultAttributeMarshaller will be used.

Parameters:

marshaller - the marshaller. Can be null

Returns:

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

setAttributeParser

public BUILDER setAttributeParser(AttributeParser parser)

Sets a custom AttributeParser to use for parsing attribute from xml. If not set, a AttributeParser.SIMPLE will be used.

Parameters:

parser - the parser. Can be null

Returns:

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

setResourceOnly

public BUILDER setResourceOnly()

Marks an attribute as only relevant to a resource, and not a valid parameter to an "add" operation that creates that resource. Typically used for legacy "name" attributes that display the final value in the resource's address as an attribute.

Returns:

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

setDeprecated

public BUILDER setDeprecated(ModelVersion since)

Marks the attribute as deprecated since the given API version.

Parameters:

since - the API version, with the API being the one (core or a subsystem) in which the attribute is used

Returns:

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

setAccessConstraints

public BUILDER setAccessConstraints(AccessConstraintDefinition... accessConstraints)

Sets access constraints to use with the attribute

Parameters:

accessConstraints - the constraints

Returns:

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

addAccessConstraint

public BUILDER addAccessConstraint(AccessConstraintDefinition accessConstraint)

Adds an access constraint to the set used with the attribute

Parameters:

accessConstraint - the constraint

Returns:

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

setNullSignificant

public BUILDER setNullSignificant(boolean nullSignificant)

Sets whether an access control check is required to implicitly set an attribute to undefined in a resource "add" operation. "Implicitly" setting an attribute refers to not providing a value for it in the add operation, leaving the attribute in an undefined state. If not set the default value is whether the attribute allows null and has a default value.

Parameters:

nullSignificant - true if an undefined value is significant

Returns:

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

setNullSignficant

@Deprecated
public BUILDER setNullSignficant(boolean nullSignficant)

Deprecated. Use setNullSignificant(boolean).

setAttributeGroup

public BUILDER setAttributeGroup(String attributeGroup)

Sets the name of the attribute group with which this attribute is associated.

Parameters:

attributeGroup - the attribute group name. Cannot be an empty string but can be null if the attribute is not associated with a group.

Returns:

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

setAllowedValues

public BUILDER setAllowedValues(org.jboss.dmr.ModelNode... allowedValues)

Sets allowed values for attribute

Parameters:

allowedValues - values that are legal as part in this attribute

Returns:

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

setAllowedValues

public BUILDER setAllowedValues(String... allowedValues)

Sets allowed values for attribute

Parameters:

allowedValues - values that are legal as part in this attribute

Returns:

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

setAllowedValues

public BUILDER setAllowedValues(int... allowedValues)

Sets allowed values for attribute

Parameters:

allowedValues - values that are legal as part in this attribute

Returns:

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

getName

public String getName()

getType

public org.jboss.dmr.ModelType getType()

getXmlName

public String getXmlName()

isAllowNull

public boolean isAllowNull()

isAllowExpression

public boolean isAllowExpression()

getDefaultValue

public org.jboss.dmr.ModelNode getDefaultValue()

getMeasurementUnit

public MeasurementUnit getMeasurementUnit()

getAlternatives

public String[] getAlternatives()

getRequires

public String[] getRequires()

getCorrector

public ParameterCorrector getCorrector()

getValidator

public ParameterValidator getValidator()

isValidateNull

public boolean isValidateNull()

getMinSize

public int getMinSize()

getMaxSize

public int getMaxSize()

getFlags

public AttributeAccess.Flag[] getFlags()

getAttributeMarshaller

public AttributeMarshaller getAttributeMarshaller()

isResourceOnly

public boolean isResourceOnly()

getDeprecated

public DeprecationData getDeprecated()

getAccessConstraints

public AccessConstraintDefinition[] getAccessConstraints()

getNullSignificant

public Boolean getNullSignificant()

getNullSignficant

@Deprecated
public Boolean getNullSignficant()

Deprecated. Use getNullSignificant().

getParser

public AttributeParser getParser()

getAttributeGroup

public String getAttributeGroup()

getAllowedValues

public org.jboss.dmr.ModelNode[] getAllowedValues()