Package org.jboss.as.controller.descriptions

Class DefaultNotificationDescriptionProvider

java.lang.Object

org.jboss.as.controller.descriptions.DefaultNotificationDescriptionProvider

All Implemented Interfaces:

DescriptionProvider

public class DefaultNotificationDescriptionProvider
extends Object
implements DescriptionProvider

Provides a default description of a notification.

Author:

Jeff Mesnil (c) 2013 Red Hat Inc.

Constructor Summary

Constructors

Constructor	Description
DefaultNotificationDescriptionProvider(NotificationDefinition definition, ResourceDescriptionResolver descriptionResolver, NotificationDefinition.DataValueDescriptor dataValueDescriptor)

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.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultNotificationDescriptionProvider

public DefaultNotificationDescriptionProvider(NotificationDefinition definition,
 ResourceDescriptionResolver descriptionResolver,
 NotificationDefinition.DataValueDescriptor dataValueDescriptor)

Method Details

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