Package org.eclipse.mat.query.registry
Class AnnotatedObjectDescriptor
- java.lang.Object
-
- org.eclipse.mat.query.registry.AnnotatedObjectDescriptor
-
- All Implemented Interfaces:
IAnnotatedObjectDescriptor
- Direct Known Subclasses:
HeapDumpProviderDescriptor
,QueryDescriptor
,VmInfoDescriptor
public class AnnotatedObjectDescriptor extends Object implements IAnnotatedObjectDescriptor
A description of the meta information attached to a class such as a query or heap dump provider.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addParameter(ArgumentDescriptor descriptor)
List<ArgumentDescriptor>
getArguments()
Get descriptors for the fields annotated by the annotationArgument
.String
getHelp()
Get the help String, for example provided by the annotationHelp
.Locale
getHelpLocale()
Get the help localeString
getHelpUrl()
Get the help URL, for example provided by the annotationHelpUrl
.URL
getIcon()
Get the Icon representing the annotated object, for example provided by the annotationIcon
.String
getIdentifier()
Get the identifier for the annotated object, for example provided by the annotationCommandName
orIAnnotatedObjectDescriptor.getName()
.String
getName()
Get the name, for example provided by the annotationName
.String
getUsage(IQueryContext context)
Get the usage information, for example provided by the annotationUsage
, or by a combination of theIAnnotatedObjectDescriptor.getIdentifier()
andArgumentDescriptor.appendUsage(java.lang.StringBuilder)
.boolean
isHelpAvailable()
Check if the object has provided some help via annotations.void
setUsage(String usage)
-
-
-
Method Detail
-
getUsage
public String getUsage(IQueryContext context)
Description copied from interface:IAnnotatedObjectDescriptor
Get the usage information, for example provided by the annotationUsage
, or by a combination of theIAnnotatedObjectDescriptor.getIdentifier()
andArgumentDescriptor.appendUsage(java.lang.StringBuilder)
.- Specified by:
getUsage
in interfaceIAnnotatedObjectDescriptor
- Parameters:
context
- used to fill in some arguments leaving usage to explain the remainder- Returns:
- the usage information for that query
-
getIcon
public URL getIcon()
Description copied from interface:IAnnotatedObjectDescriptor
Get the Icon representing the annotated object, for example provided by the annotationIcon
.- Specified by:
getIcon
in interfaceIAnnotatedObjectDescriptor
- Returns:
- the Icon as a URL
-
setUsage
public void setUsage(String usage)
-
getIdentifier
public String getIdentifier()
Description copied from interface:IAnnotatedObjectDescriptor
Get the identifier for the annotated object, for example provided by the annotationCommandName
orIAnnotatedObjectDescriptor.getName()
.- Specified by:
getIdentifier
in interfaceIAnnotatedObjectDescriptor
- Returns:
- the identifier
-
getName
public String getName()
Description copied from interface:IAnnotatedObjectDescriptor
Get the name, for example provided by the annotationName
.- Specified by:
getName
in interfaceIAnnotatedObjectDescriptor
- Returns:
- the name
-
getHelp
public String getHelp()
Description copied from interface:IAnnotatedObjectDescriptor
Get the help String, for example provided by the annotationHelp
.- Specified by:
getHelp
in interfaceIAnnotatedObjectDescriptor
- Returns:
- the help
-
getHelpUrl
public String getHelpUrl()
Description copied from interface:IAnnotatedObjectDescriptor
Get the help URL, for example provided by the annotationHelpUrl
.- Specified by:
getHelpUrl
in interfaceIAnnotatedObjectDescriptor
- Returns:
- the help URL
-
getHelpLocale
public Locale getHelpLocale()
Description copied from interface:IAnnotatedObjectDescriptor
Get the help locale- Specified by:
getHelpLocale
in interfaceIAnnotatedObjectDescriptor
- Returns:
- the locale
-
getArguments
public List<ArgumentDescriptor> getArguments()
Description copied from interface:IAnnotatedObjectDescriptor
Get descriptors for the fields annotated by the annotationArgument
. TODO Should this have been IArgumentDescriptor ?- Specified by:
getArguments
in interfaceIAnnotatedObjectDescriptor
- Returns:
- the list of annotated arguments, see
ArgumentDescriptor
-
isHelpAvailable
public boolean isHelpAvailable()
Description copied from interface:IAnnotatedObjectDescriptor
Check if the object has provided some help via annotations.- Specified by:
isHelpAvailable
in interfaceIAnnotatedObjectDescriptor
- Returns:
- true if the object or arguments were annotated with
Help
.
-
addParameter
public void addParameter(ArgumentDescriptor descriptor)
-
-