|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.mat.query.registry.AnnotatedObjectDescriptor
org.eclipse.mat.query.registry.QueryDescriptor
public class QueryDescriptor
A description of a query to be run on a snapshot, though this class is independent of the actual snapshot and uses IQueryContext.
Method Summary | |
---|---|
boolean |
accept(IQueryContext context)
Can the query be satisfied by the current context, possibly with other user supplied arguments? |
ArgumentSet |
createNewArgumentSet(IQueryContext context)
Create ArgumentSet. |
String |
explain(IQueryContext context)
Explain any parameters which cannot be filled in from the provided context. |
ArgumentDescriptor |
getArgumentByName(String name)
|
String |
getCategory()
The menu category provided by Category . |
Class<? extends IQuery> |
getCommandType()
The type of the query object, to be instantiated and the arguments injected when the query is run. |
List<QueryDescriptor> |
getMenuEntries()
|
String |
getShortDescription()
A short description of the query - about 80 characters, truncated from the full help at a sentence boundary. |
boolean |
isShallow()
Whether to not prompt the user for further arguments. |
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 |
---|
public String getCategory()
Category
.
public Class<? extends IQuery> getCommandType()
Class.newInstance()
public ArgumentSet createNewArgumentSet(IQueryContext context) throws SnapshotException
SnapshotException
public String getShortDescription()
public String toString()
toString
in class Object
public boolean accept(IQueryContext context)
context
-
public String explain(IQueryContext context)
context
-
public ArgumentDescriptor getArgumentByName(String name)
public List<QueryDescriptor> getMenuEntries()
public boolean isShallow()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |