org.jboss.as.controller

Class MapAttributeDefinition

java.lang.Object

org.jboss.as.controller.AttributeDefinition

org.jboss.as.controller.MapAttributeDefinition

Direct Known Subclasses:

PropertiesAttributeDefinition, WebContainerDefinition.PropertiesAttributeDefinition

public abstract class MapAttributeDefinition
extends AttributeDefinition

Defining characteristics of an ModelType.OBJECT attribute in a Resource, where all children of the object have values of the same type; i.e. the attribute represents a logical map of arbitrary key value pairs.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Constructor Summary

Constructors

Constructor and Description
MapAttributeDefinition(String name, boolean allowNull, ParameterValidator elementValidator)
MapAttributeDefinition(String name, String xmlName, boolean allowNull, int minSize, int maxSize, ParameterValidator elementValidator)
MapAttributeDefinition(String name, String xmlName, boolean allowNull, int minSize, int maxSize, ParameterValidator elementValidator, String[] alternatives, String[] requires, AttributeAccess.Flag... flags)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	addAttributeValueTypeDescription(org.jboss.dmr.ModelNode result, ResourceDescriptionResolver resolver, Locale locale, ResourceBundle bundle)
org.jboss.dmr.ModelNode	addOperationParameterDescription(org.jboss.dmr.ModelNode resourceDescription, String operationName, ResourceDescriptionResolver resolver, Locale locale, ResourceBundle bundle) 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.
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 abstract void	addOperationParameterValueTypeDescription(org.jboss.dmr.ModelNode result, String operationName, ResourceDescriptionResolver resolver, Locale locale, ResourceBundle bundle)
org.jboss.dmr.ModelNode	addResourceAttributeDescription(org.jboss.dmr.ModelNode resourceDescription, ResourceDescriptionResolver resolver, Locale locale, ResourceBundle bundle) Creates a returns a basic model node describing the attribute, after attaching it to the given overall resource description model node.
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 abstract void	addValueTypeDescription(org.jboss.dmr.ModelNode node, ResourceBundle bundle)
org.jboss.dmr.ModelNode	parse(String value, Location location) Creates and returns a ModelNode using the given value after first validating the node against this object's validator.
void	parseAndAddParameterElement(String key, String value, org.jboss.dmr.ModelNode operation, Location location)

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

correctValue, getAlternatives, getAttributeTextDescription, getDefaultValue, getFlags, getMeasurementUnit, getName, getNoTextDescription, getRequires, getType, getValidator, getXmlName, hasAlternative, isAllowed, isAllowExpression, isAllowNull, isMarshallable, isMarshallable, isRequired, marshallAsElement, resolveModelAttribute, validateAndSet, validateOperation, validateResolvedOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

MapAttributeDefinition

public MapAttributeDefinition(String name,
                      boolean allowNull,
                      ParameterValidator elementValidator)

MapAttributeDefinition

public MapAttributeDefinition(String name,
                      String xmlName,
                      boolean allowNull,
                      int minSize,
                      int maxSize,
                      ParameterValidator elementValidator)

MapAttributeDefinition

public MapAttributeDefinition(String name,
                      String xmlName,
                      boolean allowNull,
                      int minSize,
                      int maxSize,
                      ParameterValidator elementValidator,
                      String[] alternatives,
                      String[] requires,
                      AttributeAccess.Flag... flags)

Method Detail

parse

public org.jboss.dmr.ModelNode parse(String value,
                            Location location)
                              throws XMLStreamException

Creates and returns a ModelNode using the given value after first validating the node against this object's validator.

If value is null and a default value is available, the value of that default value will be used.

Parameters:

value - the value. Will be trimmed before use if not null.

location - current location of the parser's XMLStreamReader. Used for any exception message

Returns:

ModelNode representing the parsed value

Throws:

XMLStreamException - if value is not valid

parseAndAddParameterElement

public void parseAndAddParameterElement(String key,
                               String value,
                               org.jboss.dmr.ModelNode operation,
                               Location location)
                                 throws XMLStreamException

Throws:

XMLStreamException

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 AttributeDefinition

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 AttributeDefinition

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

addValueTypeDescription

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

addResourceAttributeDescription

public org.jboss.dmr.ModelNode addResourceAttributeDescription(org.jboss.dmr.ModelNode resourceDescription,
                                                      ResourceDescriptionResolver resolver,
                                                      Locale locale,
                                                      ResourceBundle bundle)

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 AttributeDefinition

Parameters:

resourceDescription - the overall resource description

resolver - provider of localized text descriptions

locale - locale to pass to the resolver

bundle - bundle to pass to the resolver

Returns:

the attribute description node

addAttributeValueTypeDescription

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

addOperationParameterDescription

public org.jboss.dmr.ModelNode addOperationParameterDescription(org.jboss.dmr.ModelNode resourceDescription,
                                                       String operationName,
                                                       ResourceDescriptionResolver resolver,
                                                       Locale locale,
                                                       ResourceBundle bundle)

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 AttributeDefinition

Parameters:

resourceDescription - the overall resource description

operationName - the operation name

resolver - provider of localized text descriptions

locale - locale to pass to the resolver

bundle - bundle to pass to the resolver

Returns:

the attribute description node

addOperationParameterValueTypeDescription

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