Package org.jboss.as.controller.descriptions

Class NonResolvingResourceDescriptionResolver

java.lang.Object

org.jboss.as.controller.descriptions.StandardResourceDescriptionResolver

org.jboss.as.controller.descriptions.NonResolvingResourceDescriptionResolver

All Implemented Interfaces:

ResourceDescriptionResolver

public class NonResolvingResourceDescriptionResolver
extends StandardResourceDescriptionResolver

Resource description resolver that does no resolving at all.

Author:

Tomaz Cerar (c) 2012 Red Hat Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final NonResolvingResourceDescriptionResolver	INSTANCE

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

REPLY

Constructor Summary

Constructors

Constructor	Description
NonResolvingResourceDescriptionResolver()	Deprecated, for removal: This API element is subject to removal in a future version. use INSTANCE instead

Method Summary

Modifier and Type	Method	Description
StandardResourceDescriptionResolver	getChildResolver(String key)
String	getChildTypeDescription(String childType, Locale locale, ResourceBundle bundle)	Gets the description of one of the resource's child types.
String	getOperationDeprecatedDescription(String operationName, Locale locale, ResourceBundle bundle)	Gets the description of one of the resource's operations.
String	getOperationDescription(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	getOperationParameterDescription(String operationName, String paramName, Locale locale, ResourceBundle bundle)	Gets the description of one of the resource's operation's parameters.
String	getOperationParameterValueTypeDescription(String operationName, String paramName, Locale locale, ResourceBundle bundle, String... suffixes)	Gets the description of a portion of a complex value type of one of the resource's operation's parameters.
String	getOperationReplyDescription(String operationName, Locale locale, ResourceBundle bundle)	Gets the description of the reply value for one of the resource's operations, or null if there is no description.
String	getOperationReplyValueTypeDescription(String operationName, Locale locale, ResourceBundle bundle, String... suffixes)	Gets the description of a portion of a complex value type of the reply value for one of the resource's operations, or null if there is no description.
String	getResourceAttributeDeprecatedDescription(String attributeName, Locale locale, ResourceBundle bundle)	Gets the description of one of the resource's attributes.
String	getResourceAttributeDescription(String attributeName, Locale locale, ResourceBundle bundle)	Gets the description of one of the resource's attributes.
String	getResourceAttributeValueTypeDescription(String attributeName, Locale locale, ResourceBundle bundle, String... suffixes)	Gets the description of a portion of a complex value type of one of the resource's attributes.
ResourceBundle	getResourceBundle(Locale locale)	Returns a ResourceBundle for the given Locale, or null if this resolver is not based on resource bundles.
String	getResourceDeprecatedDescription(Locale locale, ResourceBundle bundle)	Gets the description of the resource.
String	getResourceDescription(Locale locale, ResourceBundle bundle)	Gets the description of the resource.

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

getBundleKey, getKeyPrefix, getNotificationDescription, getVariableBundleKey, isReuseAttributesForAdd, isUseUnprefixedChildTypes

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final NonResolvingResourceDescriptionResolver INSTANCE

Constructor Details

NonResolvingResourceDescriptionResolver

@Deprecated(forRemoval=true)
public NonResolvingResourceDescriptionResolver()

Deprecated, for removal: This API element is subject to removal in a future version.

use INSTANCE instead

No-arg constructor.

Method Details

getResourceBundle

public ResourceBundle getResourceBundle(Locale locale)

Description copied from class: StandardResourceDescriptionResolver

Returns a ResourceBundle for the given Locale, or null if this resolver is not based on resource bundles.

This method will be invoked at least once before a series of invocations of the other methods in this interface, and the returned bundle will be passed to those methods as a parameter. The intent is to cache a resource bundle on the stack during the execution of all the methods needed to describe a resource or operation.

Specified by:

getResourceBundle in interface ResourceDescriptionResolver

Overrides:

getResourceBundle in class StandardResourceDescriptionResolver

Parameters:

locale - the locale

Returns:

the resource bundle, or null

getResourceDescription

public String getResourceDescription(Locale locale,
 ResourceBundle bundle)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of the resource.

Specified by:

getResourceDescription in interface ResourceDescriptionResolver

Overrides:

getResourceDescription 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

getResourceAttributeDescription

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

Description copied from class: StandardResourceDescriptionResolver

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

Specified by:

getResourceAttributeDescription in interface ResourceDescriptionResolver

Overrides:

getResourceAttributeDescription 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

getResourceAttributeValueTypeDescription

public String getResourceAttributeValueTypeDescription(String attributeName,
 Locale locale,
 ResourceBundle bundle,
 String... suffixes)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of a portion of a complex value type of one of the resource's attributes.

Specified by:

getResourceAttributeValueTypeDescription in interface ResourceDescriptionResolver

Overrides:

getResourceAttributeValueTypeDescription 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

suffixes - suffixes to dot-append to the base attribute key to generate a key

Returns:

the localized description

getOperationDescription

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

Description copied from class: StandardResourceDescriptionResolver

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

Specified by:

getOperationDescription in interface ResourceDescriptionResolver

Overrides:

getOperationDescription 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

getOperationParameterDescription

public String getOperationParameterDescription(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:

getOperationParameterDescription in interface ResourceDescriptionResolver

Overrides:

getOperationParameterDescription 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

getOperationParameterValueTypeDescription

public String getOperationParameterValueTypeDescription(String operationName,
 String paramName,
 Locale locale,
 ResourceBundle bundle,
 String... suffixes)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of a portion of a complex value type of one of the resource's operation's parameters.

Specified by:

getOperationParameterValueTypeDescription in interface ResourceDescriptionResolver

Overrides:

getOperationParameterValueTypeDescription 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

suffixes - suffixes to dot-append to the base attribute key to generate a key

Returns:

the localized description

getOperationReplyDescription

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

Description copied from class: StandardResourceDescriptionResolver

Gets the description of the reply value for one of the resource's operations, or null if there is no description.

Specified by:

getOperationReplyDescription in interface ResourceDescriptionResolver

Overrides:

getOperationReplyDescription 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 , or null

getOperationReplyValueTypeDescription

public String getOperationReplyValueTypeDescription(String operationName,
 Locale locale,
 ResourceBundle bundle,
 String... suffixes)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of a portion of a complex value type of the reply value for one of the resource's operations, or null if there is no description.

Specified by:

getOperationReplyValueTypeDescription in interface ResourceDescriptionResolver

Overrides:

getOperationReplyValueTypeDescription 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

suffixes - suffixes to dot-append to the base attribute key to generate a key

Returns:

the localized description , or null

getChildTypeDescription

public String getChildTypeDescription(String childType,
 Locale locale,
 ResourceBundle bundle)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of one of the resource's child types.

Specified by:

getChildTypeDescription in interface ResourceDescriptionResolver

Overrides:

getChildTypeDescription in class StandardResourceDescriptionResolver

Parameters:

childType - the name of the child type

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

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

getChildResolver

public StandardResourceDescriptionResolver getChildResolver(String key)

Overrides:

getChildResolver in class StandardResourceDescriptionResolver