org.jboss.as.controller

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

java.lang.Object

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

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

Direct Known Subclasses:

ObjectListAttributeDefinition.Builder, PrimitiveListAttributeDefinition.Builder, SimpleListAttributeDefinition.Builder, StringListAttributeDefinition.Builder

Enclosing class:

ListAttributeDefinition

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

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

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

Method Summary

Modifier and Type	Method and 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	setAllowDuplicates(boolean allowDuplicates) toggles default validator strategy to allow / not allow duplicate elements in list
BUILDER	setAllowNullElement(boolean allowNullElement) Sets whether undefined list elements are valid.
BUILDER	setElementValidator(ParameterValidator elementValidator) Sets the validator to use for validating list elements.
BUILDER	setListValidator(ParameterValidator validator) Sets an overall validator for the list.
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, getCorrector, getDefaultValue, getDeprecated, getFlags, getMeasurementUnit, getName, getNullSignficant, getNullSignificant, getParser, getRequires, getType, getUndefinedMetricValue, getXmlName, isAllowExpression, isAllowNull, isFlagPresent, isResourceOnly, isValidateNull, removeFlag, setAccessConstraints, setAllowedValues, setAllowedValues, setAllowedValues, setAllowExpression, setAllowNull, setAlternatives, setAttributeGroup, setAttributeMarshaller, setAttributeParser, setCapabilityReference, setCapabilityReference, setCapabilityReference, setCapabilityReference, setCorrector, setDefaultValue, setDeprecated, setDeprecated, setFlags, setMaxSize, setMeasurementUnit, setMinSize, 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

protected Builder(String attributeName)

Builder

protected Builder(String attributeName,
                  boolean optional)

Builder

public Builder(ListAttributeDefinition basis)

Method Detail

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 setListValidator(org.jboss.as.controller.operations.validation.ParameterValidator) to set an overall validator for the list.

Overrides:

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

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

setListValidator

public BUILDER setListValidator(ParameterValidator validator)

Sets an overall validator for the list.

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 ListAttributeDefinition.Builder,ATTRIBUTE extends ListAttributeDefinition>

getMaxSize

public int getMaxSize()

Overrides:

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

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.isAllowNull() 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

setAllowDuplicates

public BUILDER setAllowDuplicates(boolean allowDuplicates)

toggles default validator strategy to allow / not allow duplicate elements in list

Parameters:

allowDuplicates - false if duplicates are not allowed

Returns:

builder

getValidator

public ParameterValidator getValidator()

Overrides:

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