Interface IAnnotatedObjectDescriptor
-
- All Known Implementing Classes:
AnnotatedObjectDescriptor
,HeapDumpProviderDescriptor
,QueryDescriptor
,VmInfoDescriptor
public interface IAnnotatedObjectDescriptor
A descriptor which allows to inspect an annotated object, e.g. a IQuery- Since:
- 1.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<ArgumentDescriptor>
getArguments()
Get descriptors for the fields annotated by the annotationArgument
.java.lang.String
getHelp()
Get the help String, for example provided by the annotationHelp
.java.util.Locale
getHelpLocale()
Get the help localejava.lang.String
getHelpUrl()
Get the help URL, for example provided by the annotationHelpUrl
.java.net.URL
getIcon()
Get the Icon representing the annotated object, for example provided by the annotationIcon
.java.lang.String
getIdentifier()
Get the identifier for the annotated object, for example provided by the annotationCommandName
orgetName()
.java.lang.String
getName()
Get the name, for example provided by the annotationName
.java.lang.String
getUsage(IQueryContext context)
Get the usage information, for example provided by the annotationUsage
, or by a combination of thegetIdentifier()
andArgumentDescriptor.appendUsage(java.lang.StringBuilder)
.boolean
isHelpAvailable()
Check if the object has provided some help via annotations.
-
-
-
Method Detail
-
getUsage
java.lang.String getUsage(IQueryContext context)
Get the usage information, for example provided by the annotationUsage
, or by a combination of thegetIdentifier()
andArgumentDescriptor.appendUsage(java.lang.StringBuilder)
.- Parameters:
context
- used to fill in some arguments leaving usage to explain the remainder- Returns:
- the usage information for that query
-
getIcon
java.net.URL getIcon()
Get the Icon representing the annotated object, for example provided by the annotationIcon
.- Returns:
- the Icon as a URL
-
getIdentifier
java.lang.String getIdentifier()
Get the identifier for the annotated object, for example provided by the annotationCommandName
orgetName()
.- Returns:
- the identifier
-
getName
java.lang.String getName()
Get the name, for example provided by the annotationName
.- Returns:
- the name
-
getHelp
java.lang.String getHelp()
Get the help String, for example provided by the annotationHelp
.- Returns:
- the help
-
getHelpUrl
java.lang.String getHelpUrl()
Get the help URL, for example provided by the annotationHelpUrl
.- Returns:
- the help URL
-
getHelpLocale
java.util.Locale getHelpLocale()
Get the help locale- Returns:
- the locale
-
getArguments
java.util.List<ArgumentDescriptor> getArguments()
Get descriptors for the fields annotated by the annotationArgument
. TODO Should this have been IArgumentDescriptor ?- Returns:
- the list of annotated arguments, see
ArgumentDescriptor
-
isHelpAvailable
boolean isHelpAvailable()
Check if the object has provided some help via annotations.- Returns:
- true if the object or arguments were annotated with
Help
.
-
-