Package org.jboss.as.controller

Class PrimitiveListAttributeDefinition

java.lang.Object

org.jboss.as.controller.AttributeDefinition

org.jboss.as.controller.ListAttributeDefinition

org.jboss.as.controller.PrimitiveListAttributeDefinition

Direct Known Subclasses:

StringListAttributeDefinition

public class PrimitiveListAttributeDefinition
extends ListAttributeDefinition

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	Description
static class	PrimitiveListAttributeDefinition.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

COMPLEX_TYPES

Method Summary

Modifier and Type	Method	Description
protected void	addAttributeValueTypeDescription(org.jboss.dmr.ModelNode node, ResourceDescriptionResolver resolver, Locale locale, ResourceBundle bundle)
void	addCapabilityRequirements(OperationContext context, Resource resource, org.jboss.dmr.ModelNode attributeValue)	Based on the given attribute value, add capability requirements.
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)
protected void	addValueTypeDescription(org.jboss.dmr.ModelNode node, ResourceBundle bundle)
protected org.jboss.dmr.ModelNode	convertParameterElementExpressions(org.jboss.dmr.ModelNode parameterElement)	Examine the given element of a parameter list for any expression syntax, converting the relevant node to ModelType.EXPRESSION if such is supported.
AttributeDefinition	getValueAttributeDefinition()	Returns an AttributeDefinition describing the content of the list.
org.jboss.dmr.ModelType	getValueType()
void	removeCapabilityRequirements(OperationContext context, Resource resource, org.jboss.dmr.ModelNode attributeValue)	Based on the given attribute value, remove capability requirements.

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

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

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

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

Methods inherited from class java.lang.Object

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

Method Detail

getValueType

public org.jboss.dmr.ModelType getValueType()

getValueAttributeDefinition

public AttributeDefinition getValueAttributeDefinition()

Description copied from class: ListAttributeDefinition

Returns an AttributeDefinition describing the content of the list.

Overrides:

getValueAttributeDefinition in class ListAttributeDefinition

Returns:

an AttributeDefinition describing the content of the list - null if none is defined.

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

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)

convertParameterElementExpressions

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

Description copied from class: ListAttributeDefinition

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

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

addCapabilityRequirements

public void addCapabilityRequirements(OperationContext context,
                                      Resource resource,
                                      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

resource - the resource on which requirements are gathered

attributeValue - the value of the attribute described by this object

removeCapabilityRequirements

public void removeCapabilityRequirements(OperationContext context,
                                         Resource resource,
                                         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

resource - resource from which capability requirement is to be removed from, null is legal value in case that CapabilityReferenceRecorder doesn't require it.

attributeValue - the value of the attribute described by this object