org.jboss.as.controller.descriptions

Class DefaultResourceDescriptionProvider

java.lang.Object

org.jboss.as.controller.descriptions.DefaultResourceDescriptionProvider

All Implemented Interfaces:

DescriptionProvider

public class DefaultResourceDescriptionProvider
extends Object
implements DescriptionProvider

Provides a default description of a resource by analyzing the registry metadata.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Constructor Summary

Constructors

Constructor and Description
DefaultResourceDescriptionProvider(ImmutableManagementResourceRegistration registration, ResourceDescriptionResolver descriptionResolver)
DefaultResourceDescriptionProvider(ImmutableManagementResourceRegistration registration, ResourceDescriptionResolver descriptionResolver, DeprecationData deprecationData)

Method Summary

Modifier and Type	Method and Description
org.jboss.dmr.ModelNode	getModelDescription(Locale locale) Gets the descriptive information (human-friendly description, list of attributes, list of children) describing a single model node or operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultResourceDescriptionProvider

public DefaultResourceDescriptionProvider(ImmutableManagementResourceRegistration registration,
                                          ResourceDescriptionResolver descriptionResolver)

DefaultResourceDescriptionProvider

public DefaultResourceDescriptionProvider(ImmutableManagementResourceRegistration registration,
                                          ResourceDescriptionResolver descriptionResolver,
                                          DeprecationData deprecationData)

Method Detail

getModelDescription

public org.jboss.dmr.ModelNode getModelDescription(Locale locale)

Description copied from interface: DescriptionProvider

Gets the descriptive information (human-friendly description, list of attributes, list of children) describing a single model node or operation.

The implementation must assume that the caller intends to modify the returned ModelNode so it should not hand out a reference to any internal data structures.

Specified by:

getModelDescription in interface DescriptionProvider

Parameters:

locale - the locale to use to generate any localized text used in the description. May be null, in which case Locale.getDefault() should be used

Returns:

ModelNode describing the model node's structure