Package org.jboss.as.controller.descriptions

Interface DescriptionProvider

All Known Implementing Classes:
DefaultNotificationDescriptionProvider, DefaultOperationDescriptionProvider, DefaultResourceAddDescriptionProvider, DefaultResourceDescriptionProvider, DefaultResourceRemoveDescriptionProvider, GenericSubsystemDescribeHandler, UnsupportedSubsystemDescribeHandler
public interface DescriptionProvider
Provides information (description, list of attributes, list of children) describing the structure of an addressable model node or operation.
Author:
Brian Stansberry

  • Method Summary

    Modifier and Type
    Method
    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.

  • Method Details

    • getModelDescription

      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.

      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.

      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