org.jboss.as.controller

Class SimpleAttributeDefinition

java.lang.Object

org.jboss.as.controller.AttributeDefinition

org.jboss.as.controller.SimpleAttributeDefinition

Direct Known Subclasses:

ObjectTypeAttributeDefinition

public class SimpleAttributeDefinition
extends AttributeDefinition

Defining characteristics of an attribute in a Resource or a parameter or reply value type field in an OperationDefinition, with utility methods for conversion to and from xml and for validation.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Nested Class Summary

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	SimpleAttributeDefinition(AbstractAttributeDefinitionBuilder<?,? extends SimpleAttributeDefinition> builder)
	SimpleAttributeDefinition(String name, org.jboss.dmr.ModelNode defaultValue, org.jboss.dmr.ModelType type, boolean allowNull) Creates a new attribute definition.
	SimpleAttributeDefinition(String name, org.jboss.dmr.ModelNode defaultValue, org.jboss.dmr.ModelType type, boolean allowNull, AttributeAccess.Flag... flags) Creates a new attribute definition.
	SimpleAttributeDefinition(String name, org.jboss.dmr.ModelType type, boolean allowNull) Creates a new attribute definition.
	SimpleAttributeDefinition(String name, org.jboss.dmr.ModelType type, boolean allowNull, AttributeAccess.Flag... flags) Creates a new attribute definition.
	SimpleAttributeDefinition(String name, org.jboss.dmr.ModelType type, boolean allowNull, MeasurementUnit measurementUnit) Creates a new attribute definition.
	SimpleAttributeDefinition(String name, org.jboss.dmr.ModelType type, boolean allowNull, MeasurementUnit measurementUnit, AttributeAccess.Flag... flags) Creates a new attribute definition.

Method Summary

Modifier and Type	Method and Description
void	marshallAsAttribute(org.jboss.dmr.ModelNode resourceModel, boolean marshallDefault, XMLStreamWriter writer) Marshalls the value from the given resourceModel as an xml attribute, if it is marshallable.
void	marshallAsAttribute(org.jboss.dmr.ModelNode resourceModel, XMLStreamWriter writer) Marshalls the value from the given resourceModel as an xml attribute, if it is marshallable.
void	marshallAsElement(org.jboss.dmr.ModelNode resourceModel, boolean marshallDefault, XMLStreamWriter writer) Marshalls the value from the given resourceModel as an xml element, if it is marshallable.
org.jboss.dmr.ModelNode	parse(String value, XMLStreamReader reader) Creates and returns a ModelNode using the given value after first validating the node against this object's validator.
void	parseAndSetParameter(String value, org.jboss.dmr.ModelNode operation, XMLStreamReader reader) Creates a ModelNode using the given value after first validating the node against this object's validator, and then stores it in the given operation model node as a key/value pair whose key is this attribute's name.

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

addAccessConstraints, addAllowedValuesToDescription, addCapabilityRequirements, addCapabilityRequirements, addDeprecatedInfo, addOperationParameterDescription, addOperationParameterDescription, addOperationReplyDescription, addOperationReplyDescription, addResourceAttributeDescription, addResourceAttributeDescription, convertParameterExpressions, convertStringExpression, correctValue, getAccessConstraints, getAllowedValues, getAlternatives, getArbitraryDescriptors, getAttributeDeprecatedDescription, getAttributeGroup, getAttributeMarshaller, getAttributeTextDescription, getCorrector, getDefaultValue, getDeprecationData, getFlags, 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, 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

Constructor Detail

SimpleAttributeDefinition

public SimpleAttributeDefinition(String name,
                                 org.jboss.dmr.ModelType type,
                                 boolean allowNull)

Creates a new attribute definition.

Parameters:

name - the name of the attribute. Cannot be null

type - the type of the attribute value. Cannot be null

allowNull - true if ModelType.UNDEFINED is a valid type for the value

SimpleAttributeDefinition

public SimpleAttributeDefinition(String name,
                                 org.jboss.dmr.ModelType type,
                                 boolean allowNull,
                                 AttributeAccess.Flag... flags)

Creates a new attribute definition.

Parameters:

name - the name of the attribute. Cannot be null

type - the type of the attribute value. Cannot be null

allowNull - true if ModelType.UNDEFINED is a valid type for the value

flags - any flags to indicate special characteristics of the attribute

SimpleAttributeDefinition

public SimpleAttributeDefinition(String name,
                                 org.jboss.dmr.ModelType type,
                                 boolean allowNull,
                                 MeasurementUnit measurementUnit)

Creates a new attribute definition.

Parameters:

name - the name of the attribute. Cannot be null

type - the type of the attribute value. Cannot be null

allowNull - true if ModelType.UNDEFINED is a valid type for the value

measurementUnit - a measurement unit for the attribute's value. Can be null

SimpleAttributeDefinition

public SimpleAttributeDefinition(String name,
                                 org.jboss.dmr.ModelType type,
                                 boolean allowNull,
                                 MeasurementUnit measurementUnit,
                                 AttributeAccess.Flag... flags)

Creates a new attribute definition.

Parameters:

name - the name of the attribute. Cannot be null

type - the type of the attribute value. Cannot be null

allowNull - true if ModelType.UNDEFINED is a valid type for the value

measurementUnit - a measurement unit for the attribute's value. Can be null

flags - any flags to indicate special characteristics of the attribute

SimpleAttributeDefinition

public SimpleAttributeDefinition(String name,
                                 org.jboss.dmr.ModelNode defaultValue,
                                 org.jboss.dmr.ModelType type,
                                 boolean allowNull)

Creates a new attribute definition.

Parameters:

name - the name of the attribute. Cannot be null

defaultValue - a default value to use for the attribute if none is specified by the user. Can be null

type - the type of the attribute value. Cannot be null

allowNull - true if ModelType.UNDEFINED is a valid type for the value

SimpleAttributeDefinition

public SimpleAttributeDefinition(String name,
                                 org.jboss.dmr.ModelNode defaultValue,
                                 org.jboss.dmr.ModelType type,
                                 boolean allowNull,
                                 AttributeAccess.Flag... flags)

Creates a new attribute definition.

Parameters:

name - the name of the attribute. Cannot be null

defaultValue - a default value to use for the attribute if none is specified by the user. Can be null

type - the type of the attribute value. Cannot be null

allowNull - true if ModelType.UNDEFINED is a valid type for the value

flags - any flags to indicate special characteristics of the attribute

SimpleAttributeDefinition

protected SimpleAttributeDefinition(AbstractAttributeDefinitionBuilder<?,? extends SimpleAttributeDefinition> builder)

Method Detail

parse

public org.jboss.dmr.ModelNode parse(String value,
                                     XMLStreamReader reader)
                              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 an undefined node will be returned.

Parameters:

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

reader - XMLStreamReader from which the location from which the attribute value was read can be obtained and used in any XMLStreamException, in case the given value is invalid.

Returns:

ModelNode representing the parsed value

Throws:

XMLStreamException - if value is not valid

See Also:

parseAndSetParameter(String, ModelNode, XMLStreamReader)

parseAndSetParameter

public void parseAndSetParameter(String value,
                                 org.jboss.dmr.ModelNode operation,
                                 XMLStreamReader reader)
                          throws XMLStreamException

Creates a ModelNode using the given value after first validating the node against this object's validator, and then stores it in the given operation model node as a key/value pair whose key is this attribute's name.

If value is null an undefined node will be stored if such a value is acceptable to the validator.

The expected usage of this method is in parsers seeking to build up an operation to store their parsed data into the configuration.

Parameters:

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

operation - model node of type ModelType.OBJECT into which the parsed value should be stored

reader - XMLStreamReader from which the location from which the attribute value was read can be obtained and used in any XMLStreamException, in case the given value is invalid.

Throws:

XMLStreamException - if value is not valid

marshallAsAttribute

public void marshallAsAttribute(org.jboss.dmr.ModelNode resourceModel,
                                XMLStreamWriter writer)
                         throws XMLStreamException

Marshalls the value from the given resourceModel as an xml attribute, if it is marshallable.

Invoking this method is the same as calling marshallAsAttribute(resourceModel, true, writer)

Parameters:

resourceModel - the model, a non-null node of ModelType.OBJECT.

writer - stream writer to use for writing the attribute

Throws:

XMLStreamException - if writer throws an exception

marshallAsAttribute

public void marshallAsAttribute(org.jboss.dmr.ModelNode resourceModel,
                                boolean marshallDefault,
                                XMLStreamWriter writer)
                         throws XMLStreamException

Marshalls the value from the given resourceModel as an xml attribute, if it is marshallable.

Parameters:

resourceModel - the model, a non-null node of ModelType.OBJECT.

marshallDefault - true if the value should be marshalled even if it matches the default value

writer - stream writer to use for writing the attribute

Throws:

XMLStreamException - if writer throws an exception

marshallAsElement

public void marshallAsElement(org.jboss.dmr.ModelNode resourceModel,
                              boolean marshallDefault,
                              XMLStreamWriter writer)
                       throws XMLStreamException

Marshalls the value from the given resourceModel as an xml element, if it is marshallable. This implementation marshalls the attribute value as text content of the element.

Overrides:

marshallAsElement in class AttributeDefinition

Parameters:

marshallDefault -

resourceModel - the model, a non-null node of ModelType.OBJECT.

writer - stream writer to use for writing the attribute

Throws:

XMLStreamException