org.jboss.as.controller

Class SimpleListAttributeDefinition

java.lang.Object

org.jboss.as.controller.AttributeDefinition

org.jboss.as.controller.ListAttributeDefinition

org.jboss.as.controller.SimpleListAttributeDefinition

public class SimpleListAttributeDefinition
extends ListAttributeDefinition

AttributeDefinition for attributes that represent lists with simple element types (i.e. not ModelType.LIST or ModelType.OBJECT. Date: 13.10.2011

Author:

James R. Perkins, Richard Achmatowicz (c) 2012 RedHat Inc., Tomaz Cerar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleListAttributeDefinition.Builder

Nested classes/interfaces inherited from class org.jboss.as.controller.AttributeDefinition

AttributeDefinition.NameAndGroup

Field Summary

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

attributeMarshaller, COMPLEX_TYPES, referenceRecorder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleListAttributeDefinition(ListAttributeDefinition.Builder builder, AttributeDefinition valueType)

Method Summary

Modifier and Type	Method and Description
protected void	addAttributeValueTypeDescription(org.jboss.dmr.ModelNode node, ResourceDescriptionResolver resolver, Locale locale, ResourceBundle bundle)
void	addCapabilityRequirements(OperationContext context, org.jboss.dmr.ModelNode attributeValue) Based on the given attribute value, add capability requirements.
org.jboss.dmr.ModelNode	addOperationParameterDescription(ResourceBundle bundle, String prefix, org.jboss.dmr.ModelNode operationDescription) Creates a returns a basic model node describing a parameter that sets this attribute, after attaching it to the given overall operation description model node.
protected void	addOperationParameterValueTypeDescription(org.jboss.dmr.ModelNode node, String operationName, ResourceDescriptionResolver resolver, Locale locale, ResourceBundle bundle)
org.jboss.dmr.ModelNode	addResourceAttributeDescription(ResourceBundle bundle, String prefix, org.jboss.dmr.ModelNode resourceDescription) Creates a returns a basic model node describing the attribute, after attaching it to the given overall resource description model node.
protected void	addValueTypeDescription(org.jboss.dmr.ModelNode node, ResourceBundle bundle)
protected void	addValueTypeDescription(org.jboss.dmr.ModelNode node, String prefix, ResourceBundle bundle)
protected org.jboss.dmr.ModelNode	convertParameterElementExpressions(org.jboss.dmr.ModelNode parameterElement) Overrides the superclass to check that expressions are supported yet the valueType passed to the constructor is one of the complex DMR types.
protected CapabilityReferenceRecorder	getReferenceRecorder()
AttributeDefinition	getValueType()
boolean	hasCapabilityRequirements() Based on the given attribute value, tell if attribute has any capability requirements.
void	removeCapabilityRequirements(OperationContext context, org.jboss.dmr.ModelNode attributeValue) Based on the given attribute value, remove capability requirements.

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

addOperationParameterDescription, addResourceAttributeDescription, convertParameterExpressions, getElementValidator, marshallAsElement, parse, parseAndAddParameterElement, parseAndSetParameter

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

addAccessConstraints, addAllowedValuesToDescription, addDeprecatedInfo, convertStringExpression, correctValue, getAccessConstraints, getAllowedValues, getAlternatives, getArbitraryDescriptors, getAttributeDeprecatedDescription, getAttributeGroup, getAttributeMarshaller, getAttributeTextDescription, getCorrector, getDefaultValue, getDeprecationData, getFlags, getMeasurementUnit, getName, getNoTextDescription, getParser, getRequires, getType, getUndefinedMetricValue, getValidator, getXmlName, hasAlternative, isAllowed, isAllowExpression, isAllowNull, isDeprecated, isMarshallable, isMarshallable, isNullSignificant, isRequired, isResourceOnly, isValidatingNull, marshallAsElement, resolveModelAttribute, resolveModelAttribute, resolveValue, resolveValue, validateAndSet, validateOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleListAttributeDefinition

protected SimpleListAttributeDefinition(ListAttributeDefinition.Builder builder,
                                        AttributeDefinition valueType)

Method Detail

getValueType

public AttributeDefinition getValueType()

addResourceAttributeDescription

public org.jboss.dmr.ModelNode addResourceAttributeDescription(ResourceBundle bundle,
                                                               String prefix,
                                                               org.jboss.dmr.ModelNode resourceDescription)

Description copied from class: AttributeDefinition

Creates a returns a basic model node describing the attribute, after attaching it to the given overall resource description model node. The node describing the attribute is returned to make it easy to perform further modification.

Overrides:

addResourceAttributeDescription in class ListAttributeDefinition

Parameters:

bundle - resource bundle to use for text descriptions

prefix - prefix to prepend to the attribute name key when looking up descriptions

resourceDescription - the overall resource description

Returns:

the attribute description node

addOperationParameterDescription

public org.jboss.dmr.ModelNode addOperationParameterDescription(ResourceBundle bundle,
                                                                String prefix,
                                                                org.jboss.dmr.ModelNode operationDescription)

Description copied from class: AttributeDefinition

Creates a returns a basic model node describing a parameter that sets this attribute, after attaching it to the given overall operation description model node. The node describing the parameter is returned to make it easy to perform further modification.

Overrides:

addOperationParameterDescription in class ListAttributeDefinition

Parameters:

bundle - resource bundle to use for text descriptions

prefix - prefix to prepend to the attribute name key when looking up descriptions

operationDescription - the overall resource description

Returns:

the attribute description node

addCapabilityRequirements

public void addCapabilityRequirements(OperationContext context,
                                      org.jboss.dmr.ModelNode attributeValue)

Description copied from class: AttributeDefinition

Based on the given attribute value, add capability requirements. If this definition is for an attribute whose value is or contains a reference to the name of some capability, this method should record the addition of a requirement for the capability.

This is a no-op in this base class. Subclasses that support attribute types that can represent capability references should override this method.

Overrides:

addCapabilityRequirements in class AttributeDefinition

Parameters:

context - the operation context

attributeValue - the value of the attribute described by this object

removeCapabilityRequirements

public void removeCapabilityRequirements(OperationContext context,
                                         org.jboss.dmr.ModelNode attributeValue)

Description copied from class: AttributeDefinition

Based on the given attribute value, remove capability requirements. If this definition is for an attribute whose value is or contains a reference to the name of some capability, this method should record the removal of a requirement for the capability.

This is a no-op in this base class. Subclasses that support attribute types that can represent capability references should override this method.

Overrides:

removeCapabilityRequirements in class AttributeDefinition

Parameters:

context - the operation context

attributeValue - the value of the attribute described by this object

getReferenceRecorder

protected CapabilityReferenceRecorder getReferenceRecorder()

Overrides:

getReferenceRecorder in class AttributeDefinition

hasCapabilityRequirements

public boolean hasCapabilityRequirements()

Description copied from class: AttributeDefinition

Based on the given attribute value, tell if attribute has any capability requirements. If this definition is for an attribute whose value is or contains a reference to the name of some capability, this method will return true otherwise false.

This is a no-op in this base class. Subclasses that support attribute types that can represent capability references should override this method.

Overrides:

hasCapabilityRequirements in class AttributeDefinition

Returns:

addValueTypeDescription

protected void addValueTypeDescription(org.jboss.dmr.ModelNode node,
                                       ResourceBundle bundle)

Specified by:

addValueTypeDescription in class ListAttributeDefinition

addValueTypeDescription

protected void addValueTypeDescription(org.jboss.dmr.ModelNode node,
                                       String prefix,
                                       ResourceBundle bundle)

addAttributeValueTypeDescription

protected void addAttributeValueTypeDescription(org.jboss.dmr.ModelNode node,
                                                ResourceDescriptionResolver resolver,
                                                Locale locale,
                                                ResourceBundle bundle)

Specified by:

addAttributeValueTypeDescription in class ListAttributeDefinition

addOperationParameterValueTypeDescription

protected void addOperationParameterValueTypeDescription(org.jboss.dmr.ModelNode node,
                                                         String operationName,
                                                         ResourceDescriptionResolver resolver,
                                                         Locale locale,
                                                         ResourceBundle bundle)

Specified by:

addOperationParameterValueTypeDescription in class ListAttributeDefinition

convertParameterElementExpressions

protected org.jboss.dmr.ModelNode convertParameterElementExpressions(org.jboss.dmr.ModelNode parameterElement)

Overrides the superclass to check that expressions are supported yet the valueType passed to the constructor is one of the complex DMR types. If it is, an IllegalStateException is thrown, as this implementation cannot properly handle such a combination. Examine the given element of a parameter list for any expression syntax, converting the relevant node to ModelType.EXPRESSION if such is supported. This implementation will only convert elements of ModelType.STRING. Subclasses that need to handle complex elements should override this method.

Overrides:

convertParameterElementExpressions in class ListAttributeDefinition

Parameters:

parameterElement - the node to examine. Will not be null

Returns:

the parameter element with expressions converted, or the original parameter if no conversion was performed Cannot return null

Throws:

IllegalStateException - if expressions are supported, but the valueType is complex