Package org.jboss.as.controller.descriptions

Interface ResourceDescriptionResolver

All Known Subinterfaces:
ParentResourceDescriptionResolver
All Known Implementing Classes:
ChildResourceDescriptionResolver, DeprecatedResourceDescriptionResolver, NonResolvingResourceDescriptionResolver, StandardResourceDescriptionResolver, SubsystemResourceDescriptionResolver
public interface ResourceDescriptionResolver
Resolves localized text descriptions of resources and their components.
Author:
Brian Stansberry (c) 2011 Red Hat Inc.

  • Method Details

    • getResourceBundle

      ResourceBundle getResourceBundle(Locale locale)
      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.

      Parameters:
      locale - the locale
      Returns:
      the resource bundle, or null

    • getResourceDescription

      String getResourceDescription(Locale locale, ResourceBundle bundle)
      Gets the description of the resource.
      Parameters:
      locale - the locale
      bundle - a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale), or null if that call returned null
      Returns:
      the localized description

    • getResourceAttributeDescription

      String getResourceAttributeDescription(String attributeName, Locale locale, ResourceBundle bundle)
      Gets the description of one of the resource's attributes.
      Parameters:
      attributeName - the name of the attribute
      locale - the locale
      bundle - a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale), or null if that call returned null
      Returns:
      the localized description

    • getResourceAttributeValueTypeDescription

      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.
      Parameters:
      attributeName - the name of the attribute
      locale - the locale
      bundle - a resource bundle previously obtained from a call to 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

      String getOperationDescription(String operationName, Locale locale, ResourceBundle bundle)
      Gets the description of one of the resource's operations.
      Parameters:
      operationName - the name of the operation
      locale - the locale
      bundle - a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale), or null if that call returned null
      Returns:
      the localized description

    • getOperationParameterDescription

      String getOperationParameterDescription(String operationName, String paramName, Locale locale, ResourceBundle bundle)
      Gets the description of one of the resource's operation's parameters.
      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 getResourceBundle(java.util.Locale), or null if that call returned null
      Returns:
      the localized description

    • getOperationParameterValueTypeDescription

      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.
      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 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

      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.
      Parameters:
      operationName - the name of the operation
      locale - the locale
      bundle - a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale), or null if that call returned null
      Returns:
      the localized description , or null

    • getOperationReplyValueTypeDescription

      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.
      Parameters:
      operationName - the name of the operation
      locale - the locale
      bundle - a resource bundle previously obtained from a call to 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

    • getNotificationDescription

      String getNotificationDescription(String notificationType, Locale locale, ResourceBundle bundle)
      Gets the description of one of the resource's notification.
      Parameters:
      notificationType - the type of the notification
      locale - the locale
      bundle - a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale), or null if that call returned null
      Returns:
      the localized description

    • getChildTypeDescription

      String getChildTypeDescription(String childType, Locale locale, ResourceBundle bundle)
      Gets the description of one of the resource's child types.
      Parameters:
      childType - the name of the child type
      locale - the locale
      bundle - a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale), or null if that call returned null
      Returns:
      the localized description

    • getResourceDeprecatedDescription

      String getResourceDeprecatedDescription(Locale locale, ResourceBundle bundle)
      Gets the description of the resource.
      Parameters:
      locale - the locale
      bundle - a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale), or null if that call returned null
      Returns:
      the localized description

    • getResourceAttributeDeprecatedDescription

      String getResourceAttributeDeprecatedDescription(String attributeName, Locale locale, ResourceBundle bundle)
      Gets the description of one of the resource's attributes.
      Parameters:
      attributeName - the name of the attribute
      locale - the locale
      bundle - a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale), or null if that call returned null
      Returns:
      the localized description

    • getOperationDeprecatedDescription

      String getOperationDeprecatedDescription(String operationName, Locale locale, ResourceBundle bundle)
      Gets the description of one of the resource's operations.
      Parameters:
      operationName - the name of the operation
      locale - the locale
      bundle - a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale), or null if that call returned null
      Returns:
      the localized description

    • getOperationParameterDeprecatedDescription

      String getOperationParameterDeprecatedDescription(String operationName, String paramName, Locale locale, ResourceBundle bundle)
      Gets the description of one of the resource's operation's parameters.
      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 getResourceBundle(java.util.Locale), or null if that call returned null
      Returns:
      the localized description