org.eclipse.mat.query.registry
Class ArgumentDescriptor

java.lang.Object
  extended by org.eclipse.mat.query.registry.ArgumentDescriptor
All Implemented Interfaces:
IArgumentDescriptor

public class ArgumentDescriptor
extends java.lang.Object
implements IArgumentDescriptor


Constructor Summary
ArgumentDescriptor()
           
 
Method Summary
 Argument.Advice getAdvice()
          Get the Argument.Advice provided with the annotation
 java.lang.Object getDefaultValue()
          Get the default value of the field
 java.lang.reflect.Field getField()
          Get the annotated field
 java.lang.String getFlag()
          Get the flag
 java.lang.String getHelp()
          Get any help on the field provided by the annotation @Help
 java.lang.String getName()
          Get the name of the parameter
 java.lang.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(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()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ArgumentDescriptor

public ArgumentDescriptor()
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 interface IArgumentDescriptor
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 interface IArgumentDescriptor
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 interface IArgumentDescriptor
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 interface IArgumentDescriptor
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

Specified by:
getFlag in interface IArgumentDescriptor
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 interface IArgumentDescriptor
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 interface IArgumentDescriptor
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 interface IArgumentDescriptor
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 interface IArgumentDescriptor
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

Specified by:
getName in interface IArgumentDescriptor
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 interface IArgumentDescriptor
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 provided by the annotation @Help

Specified by:
getHelp in interface IArgumentDescriptor
Returns:
the help string

setHelp

public void setHelp(java.lang.String help)

getAdvice

public Argument.Advice getAdvice()
Description copied from interface: IArgumentDescriptor
Get the Argument.Advice provided with the annotation

Specified by:
getAdvice in interface IArgumentDescriptor
Returns:
the Advice

setAdvice

public void setAdvice(Argument.Advice advice)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object