Class 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.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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 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 annotation Help
      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 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
      • setDefaultValue

        public void setDefaultValue​(java.lang.Object defaultValue)
      • setField

        public void setField​(java.lang.reflect.Field field)
      • 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, for example the field name of the argument in its class.
        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, for example provided by the annotation Help
        Specified by:
        getHelp in interface IArgumentDescriptor
        Returns:
        the help string
      • setHelp

        public void setHelp​(java.lang.String help)
      • toString

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