public interface IAnnotatedObjectDescriptor
Modifier and Type | Method and Description |
---|---|
List<ArgumentDescriptor> |
getArguments()
Get descriptors for the fields annotated by the annotation
Argument . |
String |
getHelp()
Get the help String, for example provided by the annotation
Help . |
Locale |
getHelpLocale()
Get the help locale
|
String |
getHelpUrl()
Get the help URL, for example provided by the annotation
HelpUrl . |
URL |
getIcon()
Get the Icon representing the annotated object, for example provided by the annotation
Icon . |
String |
getIdentifier()
Get the identifier for the annotated object, for example provided by the annotation
CommandName
or getName() . |
String |
getName()
Get the name, for example provided by the annotation
Name . |
String |
getUsage(IQueryContext context)
Get the usage information, for example provided by the annotation
Usage , or
by a combination of the getIdentifier() and ArgumentDescriptor.appendUsage(java.lang.StringBuilder) . |
boolean |
isHelpAvailable()
Check if the object has provided some help via annotations.
|
String getUsage(IQueryContext context)
Usage
, or
by a combination of the getIdentifier()
and ArgumentDescriptor.appendUsage(java.lang.StringBuilder)
.context
- used to fill in some arguments leaving usage to explain the remainderURL getIcon()
Icon
.String getIdentifier()
CommandName
or getName()
.String getName()
Name
.String getHelp()
Help
.String getHelpUrl()
HelpUrl
.Locale getHelpLocale()
List<ArgumentDescriptor> getArguments()
Argument
.
TODO Should this have been IArgumentDescriptor ?ArgumentDescriptor
boolean isHelpAvailable()
Help
.