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, allowedValues, allowExpression, allowNull, alternatives, attributeGroup, attributeMarshaller, corrector, defaultValue, deprecated, flags, maxSize, measurementUnit, minSize, name, nullSignificant, 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
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	setCapabilityReference(CapabilityReferenceRecorder referenceRecorder) Records that this attribute's value represents a reference to an instance of a dynamic capability and assigns the object that should be used to handle adding and removing capability requirements.
SimpleAttributeDefinitionBuilder	setCapabilityReference(String referencedCapability, RuntimeCapability<?> dependentCapability) Records that this attribute's value represents a reference to an instance of a dynamic capability.
SimpleAttributeDefinitionBuilder	setCapabilityReference(String referencedCapability, String dependentCapability, boolean dynamicDependent) Records that this attribute's value represents a reference to an instance of a dynamic capability.

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

addAccessConstraint, addAlternatives, addFlag, getAccessConstraints, getAllowedValues, getAlternatives, getAttributeGroup, getAttributeMarshaller, getCorrector, getDefaultValue, getDeprecated, getFlags, getMaxSize, getMeasurementUnit, getMinSize, getName, getNullSignficant, getNullSignificant, getParser, getRequires, getType, getValidator, getXmlName, isAllowExpression, isAllowNull, isFlagPresent, isResourceOnly, isValidateNull, removeFlag, setAccessConstraints, setAllowedValues, setAllowedValues, setAllowedValues, setAllowExpression, setAllowNull, setAlternatives, setAttributeGroup, setAttributeMarshaller, setAttributeParser, setCorrector, setDefaultValue, setDeprecated, setDeprecated, setFlags, setMaxSize, setMeasurementUnit, setMinSize, setName, setNullSignficant, setNullSignificant, setRequires, setResourceOnly, setRestartAllServices, setRestartJVM, setStorageRuntime, setType, setValidateNull, setValidator, setXmlName

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)

setCapabilityReference

public SimpleAttributeDefinitionBuilder setCapabilityReference(String referencedCapability,
                                                               RuntimeCapability<?> dependentCapability)

Records that this attribute's value represents a reference to an instance of a dynamic capability.

This method is a convenience method equivalent to calling setCapabilityReference(CapabilityReferenceRecorder) passing in a CapabilityReferenceRecorder.DefaultCapabilityReferenceRecorder constructed using the parameters passed to this method.

Parameters:

referencedCapability - the name of the dynamic capability the dynamic portion of whose name is represented by the attribute's value

dependentCapability - the capability that depends on referencedCapability

Returns:

the builder

See Also:

SimpleAttributeDefinition.addCapabilityRequirements(OperationContext, ModelNode), SimpleAttributeDefinition.removeCapabilityRequirements(OperationContext, ModelNode)

setCapabilityReference

public SimpleAttributeDefinitionBuilder setCapabilityReference(String referencedCapability,
                                                               String dependentCapability,
                                                               boolean dynamicDependent)

Records that this attribute's value represents a reference to an instance of a dynamic capability.

This method is a convenience method equivalent to calling setCapabilityReference(CapabilityReferenceRecorder) passing in a CapabilityReferenceRecorder.DefaultCapabilityReferenceRecorder constructed using the parameters passed to this method.

Parameters:

referencedCapability - the name of the dynamic capability the dynamic portion of whose name is represented by the attribute's value

dependentCapability - the name of the capability that depends on referencedCapability

dynamicDependent - true if dependentCapability is a dynamic capability, the dynamic portion of which comes from the name of the resource with which the attribute is associated

Returns:

the builder

See Also:

SimpleAttributeDefinition.addCapabilityRequirements(OperationContext, ModelNode), SimpleAttributeDefinition.removeCapabilityRequirements(OperationContext, ModelNode)

setCapabilityReference

public SimpleAttributeDefinitionBuilder setCapabilityReference(CapabilityReferenceRecorder referenceRecorder)

Records that this attribute's value represents a reference to an instance of a dynamic capability and assigns the object that should be used to handle adding and removing capability requirements.

Parameters:

referenceRecorder - recorder to handle adding and removing capability requirements. May be null

Returns:

the builder

See Also:

SimpleAttributeDefinition.addCapabilityRequirements(OperationContext, ModelNode), SimpleAttributeDefinition.removeCapabilityRequirements(OperationContext, ModelNode)

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