Annotation Type Argument
-
@Target(FIELD) @Retention(RUNTIME) public @interface Argument
Annotates a member variable to be an query argument. Memory Analyzer queries implementingIQuery
use @Argument to annotate query arguments.advice()
,Argument.Advice
,isMandatory()
andflag()
can be used to further describe arguments. Heap dump providers using implementations ofIHeapDumpProvider
and subclasses ofVmInfo
can use @Argument to annotate extra arguments.
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description Argument.Advice
advice
If needed, the type of the argument.java.lang.String
flag
The name of the flag, used for query arguments table and for specifying command line arguments.boolean
isMandatory
Indicates whether the argument is mandatory (default)
-
-
-
Field Detail
-
UNFLAGGED
static final java.lang.String UNFLAGGED
A constant for theflag()
annotation parameter to show that for a command line query no flag should be specified before the argument. For a query dialog the field name without a leading dash is used as the argument name.- Since:
- 1.0
-
-
Element Detail
-
flag
java.lang.String flag
The name of the flag, used for query arguments table and for specifying command line arguments. The default, "", means use the name of the argument field.UNFLAGGED
or "none" means for the command line query no flag should be specified before the argument.- Returns:
- the name of the flag
- Default:
- ""
-
-
-
advice
Argument.Advice advice
If needed, the type of the argument.- Returns:
- the type
- Default:
- org.eclipse.mat.query.annotations.Argument.Advice.NONE
-
-