org.eclipse.mat.query.registry
Class QueryDescriptor

java.lang.Object
  extended by org.eclipse.mat.query.registry.AnnotatedObjectDescriptor
      extended by org.eclipse.mat.query.registry.QueryDescriptor
All Implemented Interfaces:
IAnnotatedObjectDescriptor

public class QueryDescriptor
extends AnnotatedObjectDescriptor


Method Summary
 boolean accept(IQueryContext context)
           
 ArgumentSet createNewArgumentSet(IQueryContext context)
          Create ArgumentSet.
 java.lang.String explain(IQueryContext context)
           
 ArgumentDescriptor getArgumentByName(java.lang.String name)
           
 java.lang.String getCategory()
           
 java.lang.Class<? extends IQuery> getCommandType()
           
 java.util.List<QueryDescriptor> getMenuEntries()
           
 java.lang.String getShortDescription()
           
 boolean isShallow()
           
 java.lang.String toString()
           
 
Methods inherited from class org.eclipse.mat.query.registry.AnnotatedObjectDescriptor
addParameter, getArguments, getHelp, getHelpLocale, getHelpUrl, getIcon, getIdentifier, getName, getUsage, isHelpAvailable, setUsage
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getCategory

public java.lang.String getCategory()

getCommandType

public java.lang.Class<? extends IQuery> getCommandType()

createNewArgumentSet

public ArgumentSet createNewArgumentSet(IQueryContext context)
                                 throws SnapshotException
Create ArgumentSet.

Throws:
SnapshotException

getShortDescription

public java.lang.String getShortDescription()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

accept

public boolean accept(IQueryContext context)

explain

public java.lang.String explain(IQueryContext context)

getArgumentByName

public ArgumentDescriptor getArgumentByName(java.lang.String name)

getMenuEntries

public java.util.List<QueryDescriptor> getMenuEntries()

isShallow

public boolean isShallow()