Package org.eclipse.mat.query.registry
Class ArgumentDescriptor
java.lang.Object
org.eclipse.mat.query.registry.ArgumentDescriptor
- All Implemented Interfaces:
IArgumentDescriptor
Provides details about an argument to be injected into a query or heap dump provider.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet theArgument.Adviceprovided with the annotationGet the default value of the fieldgetField()Get the annotated fieldgetFlag()Get the flag which is used in the command line to introduce the argument.getHelp()Get any help on the field, for example provided by the annotationHelpgetName()Get the name of the parameter, for example the field name of the argument in its class.Class<?>getType()Get the type of the annotated fieldbooleanisArray()Check if the annotated field is an arraybooleanCheck if the annotated field is a boolean or BooleanbooleanisEnum()Check if the annotated field is an EnumbooleanisList()Check if the annotated field is a ListbooleanCheck if the annotated field is a mandatory parameterbooleanCheck if the annotated field is an array or a listvoidsetAdvice(Argument.Advice advice) voidsetArray(boolean isArray) voidsetDefaultValue(Object defaultValue) voidvoidvoidvoidsetList(boolean isList) voidsetMandatory(boolean isMandatory) voidvoidtoString()
-
Constructor Details
-
ArgumentDescriptor
public ArgumentDescriptor()
-
-
Method Details
-
isMultiple
public boolean isMultiple()Description copied from interface:IArgumentDescriptorCheck if the annotated field is an array or a list- Specified by:
isMultiplein interfaceIArgumentDescriptor- Returns:
- true if the annotated field is an array or a list
-
isBoolean
public boolean isBoolean()Description copied from interface:IArgumentDescriptorCheck if the annotated field is a boolean or Boolean- Specified by:
isBooleanin interfaceIArgumentDescriptor- Returns:
- true if the annotated field is a boolean or Boolean
-
getDefaultValue
Description copied from interface:IArgumentDescriptorGet the default value of the field- Specified by:
getDefaultValuein interfaceIArgumentDescriptor- Returns:
- the default value
-
setDefaultValue
-
getField
Description copied from interface:IArgumentDescriptorGet the annotated field- Specified by:
getFieldin interfaceIArgumentDescriptor- Returns:
- the field
-
setField
-
getFlag
Description copied from interface:IArgumentDescriptorGet the flag which is used in the command line to introduce the argument. SeeArgument.flag().- Specified by:
getFlagin interfaceIArgumentDescriptor- Returns:
- the flag
-
setFlag
-
isArray
public boolean isArray()Description copied from interface:IArgumentDescriptorCheck if the annotated field is an array- Specified by:
isArrayin interfaceIArgumentDescriptor- Returns:
- true if the annotated field is an array
-
setArray
public void setArray(boolean isArray) -
isList
public boolean isList()Description copied from interface:IArgumentDescriptorCheck if the annotated field is a List- Specified by:
isListin interfaceIArgumentDescriptor- Returns:
- true if the annotated field is a List
-
setList
public void setList(boolean isList) -
isEnum
public boolean isEnum()Description copied from interface:IArgumentDescriptorCheck if the annotated field is an Enum- Specified by:
isEnumin interfaceIArgumentDescriptor- Returns:
- true if the annotated field is an Enum
-
isMandatory
public boolean isMandatory()Description copied from interface:IArgumentDescriptorCheck if the annotated field is a mandatory parameter- Specified by:
isMandatoryin interfaceIArgumentDescriptor- Returns:
- true if the annotated field is a mandatory parameter
-
setMandatory
public void setMandatory(boolean isMandatory) -
getName
Description copied from interface:IArgumentDescriptorGet the name of the parameter, for example the field name of the argument in its class.- Specified by:
getNamein interfaceIArgumentDescriptor- Returns:
- the name
-
setName
-
getType
Description copied from interface:IArgumentDescriptorGet the type of the annotated field- Specified by:
getTypein interfaceIArgumentDescriptor- Returns:
- the class of the field
-
setType
-
getHelp
Description copied from interface:IArgumentDescriptorGet any help on the field, for example provided by the annotationHelp- Specified by:
getHelpin interfaceIArgumentDescriptor- Returns:
- the help string
-
setHelp
-
getAdvice
Description copied from interface:IArgumentDescriptorGet theArgument.Adviceprovided with the annotation- Specified by:
getAdvicein interfaceIArgumentDescriptor- Returns:
- the Advice
-
setAdvice
-
toString
-