Package org.jboss.as.controller

Class MapAttributeDefinition.Builder<BUILDER extends MapAttributeDefinition.Builder<BUILDER,ATTRIBUTE>,ATTRIBUTE extends MapAttributeDefinition>

java.lang.Object

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

org.jboss.as.controller.MapAttributeDefinition.Builder<BUILDER,ATTRIBUTE>

Direct Known Subclasses:

ObjectMapAttributeDefinition.Builder, PropertiesAttributeDefinition.Builder, SimpleMapAttributeDefinition.Builder

Enclosing class:

MapAttributeDefinition

public abstract static class MapAttributeDefinition.Builder<BUILDER extends MapAttributeDefinition.Builder<BUILDER,ATTRIBUTE>,ATTRIBUTE extends MapAttributeDefinition>
extends AbstractAttributeDefinitionBuilder<BUILDER,ATTRIBUTE>

Field Summary

Fields

Modifier and Type	Field	Description
protected ParameterValidator	elementValidator

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(String attributeName)
protected	Builder(String attributeName, boolean optional)
	Builder(String attributeName, MapAttributeDefinition basis)
	Builder(MapAttributeDefinition basis)

Method Summary

Modifier and Type	Method	Description
boolean	getAllowNullElement()	Gets whether undefined list elements are valid.
ParameterValidator	getElementValidator()	Gets the validator to use for validating list elements.
int	getMaxSize()
int	getMinSize()
ParameterValidator	getValidator()
BUILDER	setAllowNullElement(boolean allowNullElement)	Sets whether undefined list elements are valid.
final BUILDER	setElementValidator(ParameterValidator elementValidator)	Sets the validator to use for validating list elements.
BUILDER	setMapValidator(ParameterValidator validator)	Sets an overall validator for the map.
BUILDER	setValidator(ParameterValidator validator)	Overrides the superclass to simply delegate to setElementValidator(org.jboss.as.controller.operations.validation.ParameterValidator).

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

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

Methods inherited from class java.lang.Object

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

Field Details

elementValidator

protected ParameterValidator elementValidator

Constructor Details

Builder

protected Builder(String attributeName)

Builder

protected Builder(String attributeName,
 boolean optional)

Builder

public Builder(String attributeName,
 MapAttributeDefinition basis)

Builder

public Builder(MapAttributeDefinition basis)

Method Details

getElementValidator

public ParameterValidator getElementValidator()

Gets the validator to use for validating list elements. En

Returns:

the validator, or null if no validator has been set

setElementValidator

public final BUILDER setElementValidator(ParameterValidator elementValidator)

Sets the validator to use for validating list elements.

Parameters:

elementValidator - the validator

Returns:

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

Throws:

IllegalArgumentException - if elementValidator is null

setValidator

public BUILDER setValidator(ParameterValidator validator)

Overrides the superclass to simply delegate to setElementValidator(org.jboss.as.controller.operations.validation.ParameterValidator). Use setMapValidator(org.jboss.as.controller.operations.validation.ParameterValidator) to set an overall validator for the map.

Overrides:

setValidator in class AbstractAttributeDefinitionBuilder<BUILDER extends MapAttributeDefinition.Builder<BUILDER,ATTRIBUTE>,ATTRIBUTE extends MapAttributeDefinition>

Parameters:

validator - the validator. Cannot be null

Returns:

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

Throws:

IllegalArgumentException - if elementValidator is null

setMapValidator

public BUILDER setMapValidator(ParameterValidator validator)

Sets an overall validator for the map.

Parameters:

validator - the validator. null is allowed

Returns:

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

getMinSize

public int getMinSize()

Overrides:

getMinSize in class AbstractAttributeDefinitionBuilder<BUILDER extends MapAttributeDefinition.Builder<BUILDER,ATTRIBUTE>,ATTRIBUTE extends MapAttributeDefinition>

getMaxSize

public int getMaxSize()

Overrides:

getMaxSize in class AbstractAttributeDefinitionBuilder<BUILDER extends MapAttributeDefinition.Builder<BUILDER,ATTRIBUTE>,ATTRIBUTE extends MapAttributeDefinition>

getAllowNullElement

public boolean getAllowNullElement()

Gets whether undefined list elements are valid. In the unlikely case setAllowNullElement(boolean) has been called, that value is returned; otherwise the value of AbstractAttributeDefinitionBuilder.isNillable() is used.

Returns:

true if undefined list elements are valid

setAllowNullElement

public BUILDER setAllowNullElement(boolean allowNullElement)

Sets whether undefined list elements are valid.

Parameters:

allowNullElement - whether undefined elements are valid

Returns:

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

getValidator

public ParameterValidator getValidator()

Overrides:

getValidator in class AbstractAttributeDefinitionBuilder<BUILDER extends MapAttributeDefinition.Builder<BUILDER,ATTRIBUTE>,ATTRIBUTE extends MapAttributeDefinition>