public interface ResourceDescriptionResolver
Modifier and Type | Method and Description |
---|---|
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, 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.
|
ResourceBundle getResourceBundle(Locale locale)
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.
locale
- the localenull
String getResourceDescription(Locale locale, ResourceBundle bundle)
locale
- the localebundle
- a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale)
,
or null
if that call returned null
String getResourceAttributeDescription(String attributeName, Locale locale, ResourceBundle bundle)
attributeName
- the name of the attributelocale
- the localebundle
- a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale)
,
or null
if that call returned null
String getResourceAttributeValueTypeDescription(String attributeName, Locale locale, ResourceBundle bundle, String... suffixes)
attributeName
- the name of the attributelocale
- the localebundle
- 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 keyString getOperationDescription(String operationName, Locale locale, ResourceBundle bundle)
operationName
- the name of the operationlocale
- the localebundle
- a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale)
,
or null
if that call returned null
String getOperationParameterDescription(String operationName, String paramName, Locale locale, ResourceBundle bundle)
operationName
- the name of the operationparamName
- the name of the operation's parameterlocale
- the localebundle
- a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale)
,
or null
if that call returned null
String getOperationParameterValueTypeDescription(String operationName, String paramName, Locale locale, ResourceBundle bundle, String... suffixes)
operationName
- the name of the operationparamName
- the name of the operation's parameterlocale
- the localebundle
- 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 keyString getOperationReplyDescription(String operationName, Locale locale, ResourceBundle bundle)
null
if there is
no description.operationName
- the name of the operationlocale
- the localebundle
- a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale)
,
or null
if that call returned null
null
String getOperationReplyValueTypeDescription(String operationName, Locale locale, ResourceBundle bundle, String... suffixes)
null
if there is
no description.operationName
- the name of the operationlocale
- the localebundle
- 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 keynull
String getNotificationDescription(String notificationType, Locale locale, ResourceBundle bundle)
notificationType
- the type of the notificationlocale
- the localebundle
- a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale)
,
or null
if that call returned null
String getChildTypeDescription(String childType, Locale locale, ResourceBundle bundle)
childType
- the name of the child typelocale
- the localebundle
- a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale)
,
or null
if that call returned null
String getResourceDeprecatedDescription(Locale locale, ResourceBundle bundle)
locale
- the localebundle
- a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale)
,
or null
if that call returned null
String getResourceAttributeDeprecatedDescription(String attributeName, Locale locale, ResourceBundle bundle)
attributeName
- the name of the attributelocale
- the localebundle
- a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale)
,
or null
if that call returned null
String getOperationDeprecatedDescription(String operationName, Locale locale, ResourceBundle bundle)
operationName
- the name of the operationlocale
- the localebundle
- a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale)
,
or null
if that call returned null
String getOperationParameterDeprecatedDescription(String operationName, String paramName, Locale locale, ResourceBundle bundle)
operationName
- the name of the operationparamName
- the name of the operation's parameterlocale
- the localebundle
- a resource bundle previously obtained from a call to getResourceBundle(java.util.Locale)
,
or null
if that call returned null
Copyright © 2023 JBoss by Red Hat. All rights reserved.