Interface JavaParameter

All Superinterfaces:
JavaAnnotatedElement, JavaModel, JavaType, Serializable
All Known Implementing Classes:
DefaultJavaParameter

public interface JavaParameter extends JavaAnnotatedElement, JavaType
JavaParameter is an extended version of JavaClass and doesn't exist in the java api.
  • Method Summary

    Modifier and Type
    Method
    Description
    Equivalent of (@link Class.getCanonicalName().
    The declaring class of the declaring method of this parameter.
    Returns the declaring method or constructor of this parameter
    Every primitive type, named package, top level class, and top level interface has a fully qualified name: The fully qualified name of a primitive type is the keyword for that primitive type, namely byte, short, char, int, long, float, double, or boolean. The fully qualified name of a named package that is not a subpackage of a named package is its simple name. The fully qualified name of a named package that is a subpackage of another named package consists of the fully qualified name of the containing package, followed by ".", followed by the simple (member) name of the subpackage. The fully qualified name of a top level class or top level interface that is declared in an unnamed package is the simple name of the class or interface. The fully qualified name of a top level class or top level interface that is declared in a named package consists of the fully qualified name of the package, followed by ".", followed by the simple name of the class or interface. Each member class, member interface, and array type may have a fully qualified name: A member class or member interface M of another class or interface C has a fully qualified name if and only if C has a fully qualified name. In that case, the fully qualified name of M consists of the fully qualified name of C, followed by ".", followed by the simple name of M. An array type has a fully qualified name if and only if its element type has a fully qualified name. In that case, the fully qualified name of an array type consists of the fully qualified name of the component type of the array type followed by "[]". Some examples how names will be translated
     
     
     
     
     
     
     
    If there's a reference to this class, use the value used in the code.
    boolean
    Is this a Java 5 var args type specified using three dots.

    Methods inherited from interface com.thoughtworks.qdox.model.JavaAnnotatedElement

    getAnnotations, getComment, getNamedParameter, getTagByName, getTags, getTagsByName

    Methods inherited from interface com.thoughtworks.qdox.model.JavaModel

    getCodeBlock, getLineNumber

    Methods inherited from interface com.thoughtworks.qdox.model.JavaType

    getBinaryName, getGenericCanonicalName, getGenericFullyQualifiedName, getGenericValue, toGenericString
  • Method Details

    • getName

      String getName()
      Returns:
      the name of the parameter
    • getType

      JavaType getType()
      Returns:
      the type of this parameter
    • getJavaClass

      JavaClass getJavaClass()
    • getExecutable

      JavaExecutable getExecutable()
      Returns the declaring method or constructor of this parameter
      Returns:
      the declaring method or constructor
    • getDeclaringClass

      JavaClass getDeclaringClass()
      The declaring class of the declaring method of this parameter.
      Returns:
      the declaring class of the declaring method
    • isVarArgs

      boolean isVarArgs()
      Is this a Java 5 var args type specified using three dots. e.g. void doStuff(Object... thing)
      Returns:
      true if this parameter is a varArg, otherwise false
      Since:
      1.6
    • getValue

      String getValue()
      Description copied from interface: JavaType
      If there's a reference to this class, use the value used in the code. Otherwise return the simple name. When including all imports, you should be safe to use this method. This won't return generics, so it's java1.4 safe. Examples:
        private String fieldA;             // getValue() will return "String"
        private java.lang.String fieldA;   // getValue() will return "java.lang.String"
        private List>String> aList;  // getValue() will return "List"
       
      Specified by:
      getValue in interface JavaType
      Returns:
      the value of the type, never null
    • getFullyQualifiedName

      String getFullyQualifiedName()
      Description copied from interface: JavaType
      Every primitive type, named package, top level class, and top level interface has a fully qualified name:
      • The fully qualified name of a primitive type is the keyword for that primitive type, namely byte, short, char, int, long, float, double, or boolean.
      • The fully qualified name of a named package that is not a subpackage of a named package is its simple name.
      • The fully qualified name of a named package that is a subpackage of another named package consists of the fully qualified name of the containing package, followed by ".", followed by the simple (member) name of the subpackage.
      • The fully qualified name of a top level class or top level interface that is declared in an unnamed package is the simple name of the class or interface.
      • The fully qualified name of a top level class or top level interface that is declared in a named package consists of the fully qualified name of the package, followed by ".", followed by the simple name of the class or interface.
      Each member class, member interface, and array type may have a fully qualified name:
      • A member class or member interface M of another class or interface C has a fully qualified name if and only if C has a fully qualified name.
      • In that case, the fully qualified name of M consists of the fully qualified name of C, followed by ".", followed by the simple name of M.
      • An array type has a fully qualified name if and only if its element type has a fully qualified name.
      • In that case, the fully qualified name of an array type consists of the fully qualified name of the component type of the array type followed by "[]".
      Some examples how names will be translated
       Object > java.lang.Object
       java.util.List > java.util.List
       ?  > ?
       T  > T
       anypackage.Outer.Inner > anypackage.Outer.Inner
       String[][] > java.lang.String[][]
       
      Specified by:
      getFullyQualifiedName in interface JavaType
      Returns:
      the FQN of the type, never null
      See Also:
    • getCanonicalName

      String getCanonicalName()
      Description copied from interface: JavaType
      Equivalent of (@link Class.getCanonicalName().
      Specified by:
      getCanonicalName in interface JavaType
      Returns:
      the canonical name of the type, never null
      Since:
      2.0
    • getResolvedValue

      String getResolvedValue()
      Returns:
      the resolved value of the type
      Since:
      1.10
    • getResolvedGenericValue

      String getResolvedGenericValue()
      Returns:
      the resolved generic value of the type, never null
      Since:
      2.0
    • getResolvedFullyQualifiedName

      String getResolvedFullyQualifiedName()
      Returns:
      the resolved FQN, never null
      Since:
      2.0
    • getResolvedGenericFullyQualifiedName

      String getResolvedGenericFullyQualifiedName()
      Returns:
      the resolved generic FQN, never null
      Since:
      2.0