|
||||||||||
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
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 provided by the annotation @Help |
java.util.Locale |
getHelpLocale()
Get the help locale |
java.lang.String |
getHelpUrl()
Get the help URL provided by the annotation @HelpURL |
java.net.URL |
getIcon()
Get the Icon provided by the annotation @Icon |
java.lang.String |
getIdentifier()
Get the identifier for the annotated object |
java.lang.String |
getName()
Get the name provided by the annotation @Name |
java.lang.String |
getUsage(IQueryContext context)
|
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)
getUsage
in interface IAnnotatedObjectDescriptor
public java.net.URL getIcon()
IAnnotatedObjectDescriptor
getIcon
in interface IAnnotatedObjectDescriptor
public void setUsage(java.lang.String usage)
public java.lang.String getIdentifier()
IAnnotatedObjectDescriptor
getIdentifier
in interface IAnnotatedObjectDescriptor
public java.lang.String getName()
IAnnotatedObjectDescriptor
getName
in interface IAnnotatedObjectDescriptor
public java.lang.String getHelp()
IAnnotatedObjectDescriptor
getHelp
in interface IAnnotatedObjectDescriptor
public java.lang.String getHelpUrl()
IAnnotatedObjectDescriptor
getHelpUrl
in interface IAnnotatedObjectDescriptor
public java.util.Locale getHelpLocale()
IAnnotatedObjectDescriptor
getHelpLocale
in interface IAnnotatedObjectDescriptor
public java.util.List<ArgumentDescriptor> getArguments()
IAnnotatedObjectDescriptor
getArguments
in interface IAnnotatedObjectDescriptor
ArgumentDescriptor
public boolean isHelpAvailable()
IAnnotatedObjectDescriptor
isHelpAvailable
in interface IAnnotatedObjectDescriptor
public void addParameter(ArgumentDescriptor descriptor)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |