|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.mat.query.registry.ArgumentDescriptor
public class ArgumentDescriptor
Provides details about an argument to be injected into a query or heap dump provider.
| Constructor Summary | |
|---|---|
ArgumentDescriptor()
|
|
| Method Summary | |
|---|---|
Argument.Advice |
getAdvice()
Get the Argument.Advice provided with the annotation |
Object |
getDefaultValue()
Get the default value of the field |
Field |
getField()
Get the annotated field |
String |
getFlag()
Get the flag which is used in the command line to introduce the argument. |
String |
getHelp()
Get any help on the field, for example provided by the annotation Help |
String |
getName()
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 field |
boolean |
isArray()
Check if the annotated field is an array |
boolean |
isBoolean()
Check if the annotated field is a boolean or Boolean |
boolean |
isEnum()
Check if the annotated field is an Enum |
boolean |
isList()
Check if the annotated field is a List |
boolean |
isMandatory()
Check if the annotated field is a mandatory parameter |
boolean |
isMultiple()
Check if the annotated field is an array or a list |
void |
setAdvice(Argument.Advice advice)
|
void |
setArray(boolean isArray)
|
void |
setDefaultValue(Object defaultValue)
|
void |
setField(Field field)
|
void |
setFlag(String flag)
|
void |
setHelp(String help)
|
void |
setList(boolean isList)
|
void |
setMandatory(boolean isMandatory)
|
void |
setName(String name)
|
void |
setType(Class<?> type)
|
String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public ArgumentDescriptor()
| Method Detail |
|---|
public boolean isMultiple()
IArgumentDescriptor
isMultiple in interface IArgumentDescriptorpublic boolean isBoolean()
IArgumentDescriptor
isBoolean in interface IArgumentDescriptorpublic Object getDefaultValue()
IArgumentDescriptor
getDefaultValue in interface IArgumentDescriptorpublic void setDefaultValue(Object defaultValue)
public Field getField()
IArgumentDescriptor
getField in interface IArgumentDescriptorpublic void setField(Field field)
public String getFlag()
IArgumentDescriptorArgument.flag().
getFlag in interface IArgumentDescriptorpublic void setFlag(String flag)
public boolean isArray()
IArgumentDescriptor
isArray in interface IArgumentDescriptorpublic void setArray(boolean isArray)
public boolean isList()
IArgumentDescriptor
isList in interface IArgumentDescriptorpublic void setList(boolean isList)
public boolean isEnum()
IArgumentDescriptor
isEnum in interface IArgumentDescriptorpublic boolean isMandatory()
IArgumentDescriptor
isMandatory in interface IArgumentDescriptorpublic void setMandatory(boolean isMandatory)
public String getName()
IArgumentDescriptor
getName in interface IArgumentDescriptorpublic void setName(String name)
public Class<?> getType()
IArgumentDescriptor
getType in interface IArgumentDescriptorpublic void setType(Class<?> type)
public String getHelp()
IArgumentDescriptorHelp
getHelp in interface IArgumentDescriptorpublic void setHelp(String help)
public Argument.Advice getAdvice()
IArgumentDescriptorArgument.Advice provided with the annotation
getAdvice in interface IArgumentDescriptorpublic void setAdvice(Argument.Advice advice)
public String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||