Class ChildResourceDescriptionResolver
- java.lang.Object
-
- org.jboss.as.controller.descriptions.ChildResourceDescriptionResolver
-
- All Implemented Interfaces:
ParentResourceDescriptionResolver
,ResourceDescriptionResolver
public class ChildResourceDescriptionResolver extends Object implements ParentResourceDescriptionResolver
Generates resource descriptions for a child resource of a subsystem.- Author:
- Paul Ferraro
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ParentResourceDescriptionResolver
createChildResolver(PathElement path, List<PathElement> alternatePaths)
Creates aResourceDescriptionResolver
whose descriptions are located via keys generated from the specified path, or the alternate path if no description was found.String
getChildTypeDescription(String childType, Locale locale, ResourceBundle bundle)
Gets the description of one of the resource's child types.String
getNotificationDescription(String notificationType, Locale locale, ResourceBundle bundle)
Gets the description of one of the resource's notification.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, ornull
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, ornull
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 aResourceBundle
for the givenLocale
, ornull
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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jboss.as.controller.descriptions.ParentResourceDescriptionResolver
createChildResolver, createChildResolver, createChildResolver, createChildResolver, createChildResolver
-
-
-
-
Method Detail
-
createChildResolver
public ParentResourceDescriptionResolver createChildResolver(PathElement path, List<PathElement> alternatePaths)
Description copied from interface:ParentResourceDescriptionResolver
Creates aResourceDescriptionResolver
whose descriptions are located via keys generated from the specified path, or the alternate path if no description was found.- Specified by:
createChildResolver
in interfaceParentResourceDescriptionResolver
- Parameters:
path
- a path element used to generate description keys- Returns:
- a resolver of resource descriptions
-
getResourceBundle
public ResourceBundle getResourceBundle(Locale locale)
Description copied from interface:ResourceDescriptionResolver
Returns aResourceBundle
for the givenLocale
, ornull
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 interfaceResourceDescriptionResolver
- Parameters:
locale
- the locale- Returns:
- the resource bundle, or
null
-
getResourceDescription
public String getResourceDescription(Locale locale, ResourceBundle bundle)
Description copied from interface:ResourceDescriptionResolver
Gets the description of the resource.- Specified by:
getResourceDescription
in interfaceResourceDescriptionResolver
- Parameters:
locale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
- Returns:
- the localized description
-
getResourceAttributeDescription
public String getResourceAttributeDescription(String attributeName, Locale locale, ResourceBundle bundle)
Description copied from interface:ResourceDescriptionResolver
Gets the description of one of the resource's attributes.- Specified by:
getResourceAttributeDescription
in interfaceResourceDescriptionResolver
- Parameters:
attributeName
- the name of the attributelocale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
- Returns:
- the localized description
-
getResourceAttributeValueTypeDescription
public String getResourceAttributeValueTypeDescription(String attributeName, Locale locale, ResourceBundle bundle, String... suffixes)
Description copied from interface:ResourceDescriptionResolver
Gets the description of a portion of a complex value type of one of the resource's attributes.- Specified by:
getResourceAttributeValueTypeDescription
in interfaceResourceDescriptionResolver
- Parameters:
attributeName
- the name of the attributelocale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
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 interface:ResourceDescriptionResolver
Gets the description of one of the resource's operations.- Specified by:
getOperationDescription
in interfaceResourceDescriptionResolver
- Parameters:
operationName
- the name of the operationlocale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
- Returns:
- the localized description
-
getOperationParameterDescription
public String getOperationParameterDescription(String operationName, String paramName, Locale locale, ResourceBundle bundle)
Description copied from interface:ResourceDescriptionResolver
Gets the description of one of the resource's operation's parameters.- Specified by:
getOperationParameterDescription
in interfaceResourceDescriptionResolver
- Parameters:
operationName
- the name of the operationparamName
- the name of the operation's parameterlocale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
- Returns:
- the localized description
-
getOperationParameterValueTypeDescription
public String getOperationParameterValueTypeDescription(String operationName, String paramName, Locale locale, ResourceBundle bundle, String... suffixes)
Description copied from interface:ResourceDescriptionResolver
Gets the description of a portion of a complex value type of one of the resource's operation's parameters.- Specified by:
getOperationParameterValueTypeDescription
in interfaceResourceDescriptionResolver
- Parameters:
operationName
- the name of the operationparamName
- the name of the operation's parameterlocale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
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 interface:ResourceDescriptionResolver
Gets the description of the reply value for one of the resource's operations, ornull
if there is no description.- Specified by:
getOperationReplyDescription
in interfaceResourceDescriptionResolver
- Parameters:
operationName
- the name of the operationlocale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
- Returns:
- the localized description , or
null
-
getOperationReplyValueTypeDescription
public String getOperationReplyValueTypeDescription(String operationName, Locale locale, ResourceBundle bundle, String... suffixes)
Description copied from interface:ResourceDescriptionResolver
Gets the description of a portion of a complex value type of the reply value for one of the resource's operations, ornull
if there is no description.- Specified by:
getOperationReplyValueTypeDescription
in interfaceResourceDescriptionResolver
- Parameters:
operationName
- the name of the operationlocale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
suffixes
- suffixes to dot-append to the base attribute key to generate a key- Returns:
- the localized description , or
null
-
getNotificationDescription
public String getNotificationDescription(String notificationType, Locale locale, ResourceBundle bundle)
Description copied from interface:ResourceDescriptionResolver
Gets the description of one of the resource's notification.- Specified by:
getNotificationDescription
in interfaceResourceDescriptionResolver
- Parameters:
notificationType
- the type of the notificationlocale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
- Returns:
- the localized description
-
getChildTypeDescription
public String getChildTypeDescription(String childType, Locale locale, ResourceBundle bundle)
Description copied from interface:ResourceDescriptionResolver
Gets the description of one of the resource's child types.- Specified by:
getChildTypeDescription
in interfaceResourceDescriptionResolver
- Parameters:
childType
- the name of the child typelocale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
- Returns:
- the localized description
-
getResourceDeprecatedDescription
public String getResourceDeprecatedDescription(Locale locale, ResourceBundle bundle)
Description copied from interface:ResourceDescriptionResolver
Gets the description of the resource.- Specified by:
getResourceDeprecatedDescription
in interfaceResourceDescriptionResolver
- Parameters:
locale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
- Returns:
- the localized description
-
getResourceAttributeDeprecatedDescription
public String getResourceAttributeDeprecatedDescription(String attributeName, Locale locale, ResourceBundle bundle)
Description copied from interface:ResourceDescriptionResolver
Gets the description of one of the resource's attributes.- Specified by:
getResourceAttributeDeprecatedDescription
in interfaceResourceDescriptionResolver
- Parameters:
attributeName
- the name of the attributelocale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
- Returns:
- the localized description
-
getOperationDeprecatedDescription
public String getOperationDeprecatedDescription(String operationName, Locale locale, ResourceBundle bundle)
Description copied from interface:ResourceDescriptionResolver
Gets the description of one of the resource's operations.- Specified by:
getOperationDeprecatedDescription
in interfaceResourceDescriptionResolver
- Parameters:
operationName
- the name of the operationlocale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
- Returns:
- the localized description
-
getOperationParameterDeprecatedDescription
public String getOperationParameterDeprecatedDescription(String operationName, String paramName, Locale locale, ResourceBundle bundle)
Description copied from interface:ResourceDescriptionResolver
Gets the description of one of the resource's operation's parameters.- Specified by:
getOperationParameterDeprecatedDescription
in interfaceResourceDescriptionResolver
- Parameters:
operationName
- the name of the operationparamName
- the name of the operation's parameterlocale
- the localebundle
- a resource bundle previously obtained from a call toResourceDescriptionResolver.getResourceBundle(java.util.Locale)
, ornull
if that call returnednull
- Returns:
- the localized description
-
-