Package org.jboss.as.controller

Class ObjectMapAttributeDefinition

java.lang.Object

org.jboss.as.controller.AttributeDefinition

org.jboss.as.controller.MapAttributeDefinition

org.jboss.as.controller.ObjectMapAttributeDefinition

public class ObjectMapAttributeDefinition
extends MapAttributeDefinition

MapAttributeDefinition for maps with keys of ModelType.STRING and values of type ObjectTypeAttributeDefinition

Since:

11.0

Author:

Tomaz Cerar

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectMapAttributeDefinition.Builder

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

AttributeDefinition.NameAndGroup

Field Summary

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

LIST_TO_MAP_CORRECTOR

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)
protected void	addValueTypeDescription(org.jboss.dmr.ModelNode node, String prefix, ResourceBundle bundle, boolean forOperation, ResourceDescriptionResolver resolver, Locale locale)
protected void	addValueTypeDescription(org.jboss.dmr.ModelNode node, ResourceBundle bundle)
static ObjectMapAttributeDefinition.Builder	create(String name, ObjectTypeAttributeDefinition valueType)
ObjectTypeAttributeDefinition	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.MapAttributeDefinition

addOperationParameterDescription, addOperationParameterDescription, addOperationReplyDescription, addResourceAttributeDescription, addResourceAttributeDescription, convertParameterElementExpressions, convertParameterExpressions, getElementValidator, marshallAsElement, parse, parseAndAddParameterElement

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

addAccessConstraints, addAllowedValuesToDescription, addDeprecatedInfo, addOperationReplyDescription, convertStringExpression, correctValue, getAccessConstraints, getAllowedValues, getAlternatives, getArbitraryDescriptors, getAttributeDeprecatedDescription, getAttributeGroup, getAttributeTextDescription, getCorrector, getDefaultValue, getDeprecationData, getFlags, getMarshaller, getMeasurementUnit, getName, getNoTextDescription, getParser, getReferenceRecorder, getRequires, getType, getUndefinedMetricValue, getValidator, getXmlName, hasAlternative, hasCapabilityRequirements, isAllowed, isAllowExpression, isDeprecated, isMarshallable, isMarshallable, isNillable, isNullSignificant, isRequired, isRequired, isResourceOnly, 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

Method Detail

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

addOperationParameterValueTypeDescription

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

Specified by:

addOperationParameterValueTypeDescription in class MapAttributeDefinition

addValueTypeDescription

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

Specified by:

addValueTypeDescription in class MapAttributeDefinition

addAttributeValueTypeDescription

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

Specified by:

addAttributeValueTypeDescription in class MapAttributeDefinition

addValueTypeDescription

protected void addValueTypeDescription(org.jboss.dmr.ModelNode node,
                                       String prefix,
                                       ResourceBundle bundle,
                                       boolean forOperation,
                                       ResourceDescriptionResolver resolver,
                                       Locale locale)

getValueType

public final ObjectTypeAttributeDefinition getValueType()

create

public static ObjectMapAttributeDefinition.Builder create(String name,
                                                          ObjectTypeAttributeDefinition valueType)