org.eclipse.mat.query.annotations.descriptors
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
 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
 

Method Detail

getUsage

java.lang.String getUsage(IQueryContext context)
Parameters:
context -
Returns:
the usage information for that query

getIcon

java.net.URL getIcon()
Get the Icon provided by the annotation @Icon

Returns:
the Icon

getIdentifier

java.lang.String getIdentifier()
Get the identifier for the annotated object

Returns:
the identifier

getName

java.lang.String getName()
Get the name provided by the annotation @Name

Returns:
the name

getHelp

java.lang.String getHelp()
Get the help String provided by the annotation @Help

Returns:
the help

getHelpUrl

java.lang.String getHelpUrl()
Get the help URL provided by the annotation @HelpURL

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 annotation @Argument

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 was annotated with help