org.eclipse.mat.query
Interface IQuery

All Known Implementing Classes:
ArrayFillRatioQuery, ArraysBySizeQuery, BigDropsQuery, BiggestObjectsPieQuery, BundleRegistryQuery, ClassLoaderExplorerQuery, ClassReferrersQuery, CollectionFillRatioQuery, CollectionsBySizeQuery, CompareTablesQuery, ComponentReportQuery, CopyActions, CopyActions.Address, CopyActions.FQClassName, CopyActions.Value, CopyOQL, CustomizedRetainedSetQuery, DominatorQuery, DuplicatedClassesQuery, ExtractListValuesQuery, FinalizerInProcessingQuery, FinalizerQuery, FinalizerQueueQuery, FinalizerReferenceStatQuery, FinalizerThreadLocalsQuery, FinalizerThreadQuery, FindLeaksQuery, FindStringsQuery, GCRootsQuery, GroupByValueQuery, HashEntriesQuery, HashSetValuesQuery, HeapDumpInfoQuery, HistogramQuery, ImmediateDominatorsQuery, LeakHunterQuery, LeakingPlugins, MapCollisionRatioQuery, MultiplePath2GCRootsQuery, ObjectListQuery, OpenSourceFileQuery, OQLQuery, Path2GCRootsQuery, PhantomReferenceStatQuery, PrimitiveArraysWithAConstantValueQuery, ReferenceQuery, RetainedSetQuery, RunExternalTest, RunRegisterdReport, SaveValueAsQuery, ShowInDominatorQuery, SoftReferenceStatQuery, SystemPropertiesQuery, ThreadInfoQuery, ThreadOverviewQuery, TopComponentsReportQuery, TopConsumers2Query, TopConsumersQuery, UnreachableObjectsQuery, WasteInCharArraysQuery, WeakReferenceStatQuery

public interface IQuery

Interface representing a query on the heap dump. Arguments can be injected into the query using public fields marked with the Argument annotation. Typical arguments for a SnapshotQuery are

Typical arguments to be supplied by the user of the query include The implementation can be tagged with the following annotations to control the placement and help in the query menus. Implementations of this interface need to be registered using the org.eclipse.mat.report.query extension point.


Method Summary
 IResult execute(IProgressListener listener)
          The execute method is called after all arguments have been injected into the query instance.
 

Method Detail

execute

IResult execute(IProgressListener listener)
                throws java.lang.Exception
The execute method is called after all arguments have been injected into the query instance. Typical results are TextResult, CompositeResult, SectionSpec etc.

Parameters:
listener - Monitor to report progress and check for cancellation.
Returns:
The result of the query.
Throws:
java.lang.Exception