Package org.eclipse.mat.query.registry
Class ArgumentDescriptor
- java.lang.Object
-
- org.eclipse.mat.query.registry.ArgumentDescriptor
-
- All Implemented Interfaces:
IArgumentDescriptor
public class ArgumentDescriptor extends java.lang.Object implements IArgumentDescriptor
Provides details about an argument to be injected into a query or heap dump provider.
-
-
Constructor Summary
Constructors Constructor Description ArgumentDescriptor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Argument.Advice
getAdvice()
Get theArgument.Advice
provided with the annotationjava.lang.Object
getDefaultValue()
Get the default value of the fieldjava.lang.reflect.Field
getField()
Get the annotated fieldjava.lang.String
getFlag()
Get the flag which is used in the command line to introduce the argument.java.lang.String
getHelp()
Get any help on the field, for example provided by the annotationHelp
java.lang.String
getName()
Get the name of the parameter, for example the field name of the argument in its class.java.lang.Class<?>
getType()
Get the type of the annotated fieldboolean
isArray()
Check if the annotated field is an arrayboolean
isBoolean()
Check if the annotated field is a boolean or Booleanboolean
isEnum()
Check if the annotated field is an Enumboolean
isList()
Check if the annotated field is a Listboolean
isMandatory()
Check if the annotated field is a mandatory parameterboolean
isMultiple()
Check if the annotated field is an array or a listvoid
setAdvice(Argument.Advice advice)
void
setArray(boolean isArray)
void
setDefaultValue(java.lang.Object defaultValue)
void
setField(java.lang.reflect.Field field)
void
setFlag(java.lang.String flag)
void
setHelp(java.lang.String help)
void
setList(boolean isList)
void
setMandatory(boolean isMandatory)
void
setName(java.lang.String name)
void
setType(java.lang.Class<?> type)
java.lang.String
toString()
-
-
-
Method Detail
-
isMultiple
public boolean isMultiple()
Description copied from interface:IArgumentDescriptor
Check if the annotated field is an array or a list- Specified by:
isMultiple
in interfaceIArgumentDescriptor
- Returns:
- true if the annotated field is an array or a list
-
isBoolean
public boolean isBoolean()
Description copied from interface:IArgumentDescriptor
Check if the annotated field is a boolean or Boolean- Specified by:
isBoolean
in interfaceIArgumentDescriptor
- Returns:
- true if the annotated field is a boolean or Boolean
-
getDefaultValue
public java.lang.Object getDefaultValue()
Description copied from interface:IArgumentDescriptor
Get the default value of the field- Specified by:
getDefaultValue
in interfaceIArgumentDescriptor
- Returns:
- the default value
-
setDefaultValue
public void setDefaultValue(java.lang.Object defaultValue)
-
getField
public java.lang.reflect.Field getField()
Description copied from interface:IArgumentDescriptor
Get the annotated field- Specified by:
getField
in interfaceIArgumentDescriptor
- Returns:
- the field
-
setField
public void setField(java.lang.reflect.Field field)
-
getFlag
public java.lang.String getFlag()
Description copied from interface:IArgumentDescriptor
Get the flag which is used in the command line to introduce the argument. SeeArgument.flag()
.- Specified by:
getFlag
in interfaceIArgumentDescriptor
- Returns:
- the flag
-
setFlag
public void setFlag(java.lang.String flag)
-
isArray
public boolean isArray()
Description copied from interface:IArgumentDescriptor
Check if the annotated field is an array- Specified by:
isArray
in interfaceIArgumentDescriptor
- Returns:
- true if the annotated field is an array
-
setArray
public void setArray(boolean isArray)
-
isList
public boolean isList()
Description copied from interface:IArgumentDescriptor
Check if the annotated field is a List- Specified by:
isList
in interfaceIArgumentDescriptor
- Returns:
- true if the annotated field is a List
-
setList
public void setList(boolean isList)
-
isEnum
public boolean isEnum()
Description copied from interface:IArgumentDescriptor
Check if the annotated field is an Enum- Specified by:
isEnum
in interfaceIArgumentDescriptor
- Returns:
- true if the annotated field is an Enum
-
isMandatory
public boolean isMandatory()
Description copied from interface:IArgumentDescriptor
Check if the annotated field is a mandatory parameter- Specified by:
isMandatory
in interfaceIArgumentDescriptor
- Returns:
- true if the annotated field is a mandatory parameter
-
setMandatory
public void setMandatory(boolean isMandatory)
-
getName
public java.lang.String getName()
Description copied from interface:IArgumentDescriptor
Get the name of the parameter, for example the field name of the argument in its class.- Specified by:
getName
in interfaceIArgumentDescriptor
- Returns:
- the name
-
setName
public void setName(java.lang.String name)
-
getType
public java.lang.Class<?> getType()
Description copied from interface:IArgumentDescriptor
Get the type of the annotated field- Specified by:
getType
in interfaceIArgumentDescriptor
- Returns:
- the class of the field
-
setType
public void setType(java.lang.Class<?> type)
-
getHelp
public java.lang.String getHelp()
Description copied from interface:IArgumentDescriptor
Get any help on the field, for example provided by the annotationHelp
- Specified by:
getHelp
in interfaceIArgumentDescriptor
- Returns:
- the help string
-
setHelp
public void setHelp(java.lang.String help)
-
getAdvice
public Argument.Advice getAdvice()
Description copied from interface:IArgumentDescriptor
Get theArgument.Advice
provided with the annotation- Specified by:
getAdvice
in interfaceIArgumentDescriptor
- Returns:
- the Advice
-
setAdvice
public void setAdvice(Argument.Advice advice)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-