org.jboss.as.controller.descriptions

Class DeprecatedResourceDescriptionResolver

java.lang.Object

org.jboss.as.controller.descriptions.StandardResourceDescriptionResolver

org.jboss.as.controller.descriptions.DeprecatedResourceDescriptionResolver

All Implemented Interfaces:

ResourceDescriptionResolver

public class DeprecatedResourceDescriptionResolver
extends StandardResourceDescriptionResolver

Resource resolver that in case that doesn't find deprecated description uses subsystem-name.deprecated key. This is useful when you need to deprecate whole subsystem and don't want to add deprecated key entries for each any every resource / attribute / operation

Author:

Tomaz Cerar (c) 2015 Red Hat Inc.

Field Summary

Fields inherited from class org.jboss.as.controller.descriptions.StandardResourceDescriptionResolver

REPLY

Constructor Summary

Constructors

Constructor and Description
DeprecatedResourceDescriptionResolver(String subsystemName, String keyPrefix, String bundleBaseName, ClassLoader bundleLoader)
DeprecatedResourceDescriptionResolver(String subsystemName, String keyPrefix, String bundleBaseName, ClassLoader bundleLoader, boolean reuseAttributesForAdd, boolean useUnprefixedChildTypes)

Method Summary

Modifier and Type	Method and Description
String	getOperationDeprecatedDescription(String operationName, Locale locale, ResourceBundle bundle) Gets the description of one of the resource's operations.
String	getOperationParameterDeprecatedDescription(String operationName, String paramName, Locale locale, ResourceBundle bundle) Gets the description of one of the resource's operation's parameters.
String	getResourceAttributeDeprecatedDescription(String attributeName, Locale locale, ResourceBundle bundle) Gets the description of one of the resource's attributes.
String	getResourceDeprecatedDescription(Locale locale, ResourceBundle bundle) Gets the description of the resource.

Methods inherited from class org.jboss.as.controller.descriptions.StandardResourceDescriptionResolver

getBundleKey, getChildResolver, getChildTypeDescription, getKeyPrefix, getNotificationDescription, getOperationDescription, getOperationParameterDescription, getOperationParameterValueTypeDescription, getOperationReplyDescription, getOperationReplyValueTypeDescription, getResourceAttributeDescription, getResourceAttributeValueTypeDescription, getResourceBundle, getResourceDescription, isReuseAttributesForAdd, isUseUnprefixedChildTypes

Methods inherited from class java.lang.Object

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

Constructor Detail

DeprecatedResourceDescriptionResolver

public DeprecatedResourceDescriptionResolver(String subsystemName,
                                             String keyPrefix,
                                             String bundleBaseName,
                                             ClassLoader bundleLoader)

DeprecatedResourceDescriptionResolver

public DeprecatedResourceDescriptionResolver(String subsystemName,
                                             String keyPrefix,
                                             String bundleBaseName,
                                             ClassLoader bundleLoader,
                                             boolean reuseAttributesForAdd,
                                             boolean useUnprefixedChildTypes)

Method Detail

getOperationDeprecatedDescription

public String getOperationDeprecatedDescription(String operationName,
                                                Locale locale,
                                                ResourceBundle bundle)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of one of the resource's operations.

Specified by:

getOperationDeprecatedDescription in interface ResourceDescriptionResolver

Overrides:

getOperationDeprecatedDescription in class StandardResourceDescriptionResolver

Parameters:

operationName - the name of the operation

locale - the locale

bundle - a resource bundle previously obtained from a call to ResourceDescriptionResolver.getResourceBundle(java.util.Locale), or null if that call returned null

Returns:

the localized description

getOperationParameterDeprecatedDescription

public String getOperationParameterDeprecatedDescription(String operationName,
                                                         String paramName,
                                                         Locale locale,
                                                         ResourceBundle bundle)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of one of the resource's operation's parameters.

Specified by:

getOperationParameterDeprecatedDescription in interface ResourceDescriptionResolver

Overrides:

getOperationParameterDeprecatedDescription in class StandardResourceDescriptionResolver

Parameters:

operationName - the name of the operation

paramName - the name of the operation's parameter

locale - the locale

bundle - a resource bundle previously obtained from a call to ResourceDescriptionResolver.getResourceBundle(java.util.Locale), or null if that call returned null

Returns:

the localized description

getResourceDeprecatedDescription

public String getResourceDeprecatedDescription(Locale locale,
                                               ResourceBundle bundle)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of the resource.

Specified by:

getResourceDeprecatedDescription in interface ResourceDescriptionResolver

Overrides:

getResourceDeprecatedDescription in class StandardResourceDescriptionResolver

Parameters:

locale - the locale

bundle - a resource bundle previously obtained from a call to ResourceDescriptionResolver.getResourceBundle(java.util.Locale), or null if that call returned null

Returns:

the localized description

getResourceAttributeDeprecatedDescription

public String getResourceAttributeDeprecatedDescription(String attributeName,
                                                        Locale locale,
                                                        ResourceBundle bundle)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of one of the resource's attributes.

Specified by:

getResourceAttributeDeprecatedDescription in interface ResourceDescriptionResolver

Overrides:

getResourceAttributeDeprecatedDescription in class StandardResourceDescriptionResolver

Parameters:

attributeName - the name of the attribute

locale - the locale

bundle - a resource bundle previously obtained from a call to ResourceDescriptionResolver.getResourceBundle(java.util.Locale), or null if that call returned null

Returns:

the localized description