|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.mat.query.registry.AnnotatedObjectDescriptor
public class AnnotatedObjectDescriptor
A description of the meta information attached to a class such as a query or heap dump provider.
Constructor Summary | |
---|---|
AnnotatedObjectDescriptor(java.lang.String identifier,
java.lang.String name,
java.lang.String usage,
java.net.URL icon,
java.lang.String help,
java.lang.String helpUrl,
java.util.Locale helpLocale)
|
Method Summary | |
---|---|
void |
addParameter(ArgumentDescriptor descriptor)
|
java.util.List<ArgumentDescriptor> |
getArguments()
Get descriptors for the fields annotated by the annotation Argument . |
java.lang.String |
getHelp()
Get the help String, for example provided by the annotation Help . |
java.util.Locale |
getHelpLocale()
Get the help locale |
java.lang.String |
getHelpUrl()
Get the help URL, for example provided by the annotation HelpUrl . |
java.net.URL |
getIcon()
Get the Icon representing the annotated object, for example provided by the annotation Icon . |
java.lang.String |
getIdentifier()
Get the identifier for the annotated object, for example provided by the annotation CommandName
or IAnnotatedObjectDescriptor.getName() . |
java.lang.String |
getName()
Get the name, for example provided by the annotation Name . |
java.lang.String |
getUsage(IQueryContext context)
Get the usage information, for example provided by the annotation Usage , or
by a combination of the IAnnotatedObjectDescriptor.getIdentifier() and ArgumentDescriptor.appendUsage(java.lang.StringBuilder) . |
boolean |
isHelpAvailable()
Check if the object has provided some help via annotations. |
void |
setUsage(java.lang.String usage)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AnnotatedObjectDescriptor(java.lang.String identifier, java.lang.String name, java.lang.String usage, java.net.URL icon, java.lang.String help, java.lang.String helpUrl, java.util.Locale helpLocale)
Method Detail |
---|
public java.lang.String getUsage(IQueryContext context)
IAnnotatedObjectDescriptor
Usage
, or
by a combination of the IAnnotatedObjectDescriptor.getIdentifier()
and ArgumentDescriptor.appendUsage(java.lang.StringBuilder)
.
getUsage
in interface IAnnotatedObjectDescriptor
context
- used to fill in some arguments leaving usage to explain the remainder
public java.net.URL getIcon()
IAnnotatedObjectDescriptor
Icon
.
getIcon
in interface IAnnotatedObjectDescriptor
public void setUsage(java.lang.String usage)
public java.lang.String getIdentifier()
IAnnotatedObjectDescriptor
CommandName
or IAnnotatedObjectDescriptor.getName()
.
getIdentifier
in interface IAnnotatedObjectDescriptor
public java.lang.String getName()
IAnnotatedObjectDescriptor
Name
.
getName
in interface IAnnotatedObjectDescriptor
public java.lang.String getHelp()
IAnnotatedObjectDescriptor
Help
.
getHelp
in interface IAnnotatedObjectDescriptor
public java.lang.String getHelpUrl()
IAnnotatedObjectDescriptor
HelpUrl
.
getHelpUrl
in interface IAnnotatedObjectDescriptor
public java.util.Locale getHelpLocale()
IAnnotatedObjectDescriptor
getHelpLocale
in interface IAnnotatedObjectDescriptor
public java.util.List<ArgumentDescriptor> getArguments()
IAnnotatedObjectDescriptor
Argument
.
TODO Should this have been IArgumentDescriptor ?
getArguments
in interface IAnnotatedObjectDescriptor
ArgumentDescriptor
public boolean isHelpAvailable()
IAnnotatedObjectDescriptor
isHelpAvailable
in interface IAnnotatedObjectDescriptor
Help
.public void addParameter(ArgumentDescriptor descriptor)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |