org.jboss.as.clustering.subsystem

Class ObjectTypeAttributeDefinition

java.lang.Object

org.jboss.as.controller.AttributeDefinition

org.jboss.as.controller.SimpleAttributeDefinition

org.jboss.as.clustering.subsystem.ObjectTypeAttributeDefinition

public class ObjectTypeAttributeDefinition
extends SimpleAttributeDefinition

Date: 15.11.2011

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectTypeAttributeDefinition.Builder

Method Summary

Methods

Modifier and Type	Method and Description
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.
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, String prefix, ResourceBundle bundle)
void	marshallAsElement(org.jboss.dmr.ModelNode resourceModel, 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.

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

marshallAsAttribute, marshallAsAttribute, marshallAsElement, parse, parseAndSetParameter, parseAndSetParameter

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

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

Methods inherited from class java.lang.Object

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

Method Detail

parse

public org.jboss.dmr.ModelNode parse(String value,
                            XMLStreamReader reader)
                              throws XMLStreamException

Description copied from class: SimpleAttributeDefinition

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.

Overrides:

parse in class SimpleAttributeDefinition

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:

SimpleAttributeDefinition.parseAndSetParameter(String, ModelNode, XMLStreamReader)

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 void addValueTypeDescription(org.jboss.dmr.ModelNode node,
                           String prefix,
                           ResourceBundle bundle)

marshallAsElement

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

Description copied from class: SimpleAttributeDefinition

Marshalls the value from the given resourceModel as an xml element, if it is marshallable. Invoking this method is the same as calling marshallAsElementText(resourceModel, true, writer)

Overrides:

marshallAsElement in class SimpleAttributeDefinition

Parameters:

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

writer - stream writer to use for writing the attribute

Throws:

XMLStreamException - if thrown by writer