org.jboss.as.controller

Class SimpleListAttributeDefinition.Builder

java.lang.Object

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

org.jboss.as.controller.ListAttributeDefinition.Builder<SimpleListAttributeDefinition.Builder,SimpleListAttributeDefinition>

org.jboss.as.controller.SimpleListAttributeDefinition.Builder

Enclosing class:

SimpleListAttributeDefinition

public static class SimpleListAttributeDefinition.Builder
extends ListAttributeDefinition.Builder<SimpleListAttributeDefinition.Builder,SimpleListAttributeDefinition>

Field Summary

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

accessConstraints, allowedValues, allowExpression, allowNull, alternatives, arbitraryDescriptors, attributeGroup, attributeMarshaller, corrector, defaultValue, deprecated, flags, maxSize, measurementUnit, minSize, name, nullSignificant, parser, referenceRecorder, requires, resourceOnly, type, validateNull, validator, xmlName

Constructor Summary

Constructors

Constructor and Description
Builder(SimpleListAttributeDefinition basis)
Builder(String name, AttributeDefinition valueType)

Method Summary

Modifier and Type	Method and Description
SimpleListAttributeDefinition	build() Create the AttributeDefinition
static SimpleListAttributeDefinition.Builder	of(String name, AttributeDefinition valueType)
SimpleListAttributeDefinition.Builder	setAllowNull(boolean allowNull) Inverse of the preferred AbstractAttributeDefinitionBuilder.setRequired(boolean); sets whether the attribute should allow undefined values in the absence of alternatives.
SimpleListAttributeDefinition.Builder	setMaxSize(int maxSize) Sets a maximum size for a collection-type attribute or one whose value is a string or byte[].
SimpleListAttributeDefinition.Builder	setMinSize(int minSize) Sets a minimum size description for a collection-type attribute or one whose value is a string or byte[].
SimpleListAttributeDefinition.Builder	setWrapXmlList(boolean wrap)

Methods inherited from class org.jboss.as.controller.ListAttributeDefinition.Builder

getAllowNullElement, getElementValidator, getMaxSize, getMinSize, getValidator, setAllowDuplicates, setAllowNullElement, setElementValidator, setListValidator, setValidator

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

addAccessConstraint, addAlternatives, addArbitraryDescriptor, addFlag, getAccessConstraints, getAllowedValues, getAlternatives, getArbitraryDescriptors, getAttributeGroup, getAttributeMarshaller, getCapabilityReferenceRecorder, getCorrector, getDefaultValue, getDeprecated, getFlags, getMeasurementUnit, getName, getNullSignificant, getParser, getRequires, getType, getUndefinedMetricValue, getXmlName, isAllowExpression, isAllowNull, isFlagPresent, isResourceOnly, isValidateNull, removeAlternatives, removeFlag, setAccessConstraints, setAllowedValues, setAllowedValues, setAllowedValues, setAllowExpression, setAlternatives, setAttributeGroup, setAttributeMarshaller, setAttributeParser, setCapabilityReference, setCapabilityReference, setCapabilityReference, setCapabilityReference, setCapabilityReference, setCapabilityReference, setCapabilityReference, setCorrector, setDefaultValue, setDeprecated, setDeprecated, setExpressionsDeprecated, setFlags, setMeasurementUnit, setName, setNullSignficant, setNullSignificant, setRequired, setRequires, setResourceOnly, setRestartAllServices, setRestartJVM, setRuntimeServiceNotRequired, setStorageRuntime, setType, setUndefinedMetricValue, setValidateNull, setXmlName

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String name,
               AttributeDefinition valueType)

Builder

public Builder(SimpleListAttributeDefinition basis)

Method Detail

of

public static SimpleListAttributeDefinition.Builder of(String name,
                                                       AttributeDefinition valueType)

setWrapXmlList

public SimpleListAttributeDefinition.Builder setWrapXmlList(boolean wrap)

build

public SimpleListAttributeDefinition build()

Description copied from class: AbstractAttributeDefinitionBuilder

Create the AttributeDefinition

Specified by:

build in class AbstractAttributeDefinitionBuilder<SimpleListAttributeDefinition.Builder,SimpleListAttributeDefinition>

Returns:

the attribute definition. Will not return null

setAllowNull

public SimpleListAttributeDefinition.Builder setAllowNull(boolean allowNull)

Description copied from class: AbstractAttributeDefinitionBuilder

Inverse of the preferred AbstractAttributeDefinitionBuilder.setRequired(boolean); sets whether the attribute should allow undefined values in the absence of alternatives. 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<SimpleListAttributeDefinition.Builder,SimpleListAttributeDefinition>

Parameters:

allowNull - true if undefined values should be allowed in the absence of alternatives

Returns:

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

setMaxSize

public SimpleListAttributeDefinition.Builder setMaxSize(int maxSize)

Description copied from class: AbstractAttributeDefinitionBuilder

Sets a maximum size for a collection-type attribute or one whose value is a string or byte[]. The value represents the maximum number of elements in the collection, or the maximum length of the string or array. It does not represent a maximum value for a numeric attribute and should not be configured for numeric attributes.

Overrides:

setMaxSize in class AbstractAttributeDefinitionBuilder<SimpleListAttributeDefinition.Builder,SimpleListAttributeDefinition>

Parameters:

maxSize - the maximum size

Returns:

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

setMinSize

public SimpleListAttributeDefinition.Builder setMinSize(int minSize)

Description copied from class: AbstractAttributeDefinitionBuilder

Sets a minimum size description for a collection-type attribute or one whose value is a string or byte[]. The value represents the minimum number of elements in the collection, or the minimum length of the string or array. It does not represent a minimum value for a numeric attribute and should not be configured for numeric attributes.

Overrides:

setMinSize in class AbstractAttributeDefinitionBuilder<SimpleListAttributeDefinition.Builder,SimpleListAttributeDefinition>

Parameters:

minSize - the minimum size

Returns:

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