DefaultJavaParameter (QDox 2.0-M3 API)

java.lang.Object
- com.thoughtworks.qdox.model.impl.AbstractJavaModel
- - com.thoughtworks.qdox.model.impl.AbstractBaseJavaEntity
  - - com.thoughtworks.qdox.model.impl.DefaultJavaParameter

All Implemented Interfaces:

JavaAnnotatedElement, JavaModel, JavaParameter, JavaType, Serializable
```
public class DefaultJavaParameter
extends AbstractBaseJavaEntity
implements JavaParameter
```
See Also:
Serialized Form

Field Summary
- Fields inherited from interface com.thoughtworks.qdox.model.JavaType
  VOID

Constructor Summary

Constructors
Constructor and Description
`DefaultJavaParameter(JavaClass type, String name)`
`DefaultJavaParameter(JavaClass type, String name, boolean varArgs)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getCanonicalName()` Equivalent of (@link `Class.getCanonicalName()`.
`String`	`getCodeBlock()`
`ParameterDeclarator`	`getDeclarator()` Returns the declaring method or constructor of this parameter
`String`	`getFullyQualifiedName()` Returns the FQN of an Object or the handler of a Type.
`String`	`getGenericCanonicalName()` The canonical name with generic information.
`String`	`getGenericFullyQualifiedName()` The fully qualified nate with generic information.
`String`	`getGenericValue()` A java5+ representation of the class.
`JavaClass`	`getJavaClass()`
`String`	`getName()`
`JavaClass`	`getParentClass()` Not every entity has a parentClass, but AnnotationFieldRef requires access to it.
`String`	`getResolvedFullyQualifiedName()`
`String`	`getResolvedGenericFullyQualifiedName()`
`String`	`getResolvedGenericValue()`
`String`	`getResolvedValue()`
`JavaType`	`getType()`
`String`	`getValue()` If there's a reference to this class, use the value used in the code.
`int`	`hashCode()`
`boolean`	`isVarArgs()` Is this a Java 5 var args type specified using three dots.
`void`	`setDeclarator(ParameterDeclarator declarator)`
`void`	`setName(String name)`
`String`	`toGenericString()`
`String`	`toString()`

Methods inherited from class com.thoughtworks.qdox.model.impl.AbstractBaseJavaEntity
getAnnotations, getComment, getNamedParameter, getTagByName, getTags, getTagsByName, setAnnotations, setComment, setTags

Methods inherited from class com.thoughtworks.qdox.model.impl.AbstractJavaModel
getLineNumber, getModelWriter, getSource, setLineNumber, setModelWriterFactory, setSource

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.thoughtworks.qdox.model.JavaAnnotatedElement
getAnnotations, getComment, getNamedParameter, getTagByName, getTags, getTagsByName

- Constructor Detail
  - DefaultJavaParameter
```
public DefaultJavaParameter(JavaClass type,
                    String name)
```
  - DefaultJavaParameter
```
public DefaultJavaParameter(JavaClass type,
                    String name,
                    boolean varArgs)
```
- Method Detail
  - getCodeBlock
```
public String getCodeBlock()
```
    Specified by:
    
    getCodeBlock in interface JavaModel
    
    Returns:
    the codeblock
  - setName
```
public void setName(String name)
```
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface JavaParameter
    
    Returns:
    the name of the parameter
  - getType
```
public JavaType getType()
```
    Specified by:
    
    getType in interface JavaParameter
    
    Returns:
    the type of this parameter
  - getJavaClass
```
public JavaClass getJavaClass()
```
    Specified by:
    
    getJavaClass in interface JavaParameter
  - getDeclarator
```
public ParameterDeclarator getDeclarator()
```
    Returns the declaring method or constructor of this parameter
    
    Specified by:
    
    getDeclarator in interface JavaParameter
    
    Returns:
    the declaring method or constructor
  - setDeclarator
```
public void setDeclarator(ParameterDeclarator declarator)
```
  - getParentClass
```
public JavaClass getParentClass()
```
    Not every entity has a parentClass, but AnnotationFieldRef requires access to it. When used with JavaClass, don't confuse this with getSuperClass()
    
    Specified by:
    
    getParentClass in interface JavaParameter
    
    Overrides:
    
    getParentClass in class AbstractBaseJavaEntity
    
    Returns:
    the surrounding class
  - isVarArgs
```
public boolean isVarArgs()
```
    Is this a Java 5 var args type specified using three dots. e.g. void doStuff(Object... thing)
    
    Specified by:
    
    isVarArgs in interface JavaParameter
  - getFullyQualifiedName
```
public String getFullyQualifiedName()
```
    Returns the FQN of an Object or the handler of a Type. If the name of the can't be resolved based on the imports and the classes on the classpath the name will be returned. InnerClasses will use the $ sign. If the type is an array, the brackets will be included. The get only the name, use #getComponentType(). 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 JavaParameter
    
    Specified by:
    
    getFullyQualifiedName in interface JavaType
    
    Returns:
    the FQN of the type, never null
    See Also:
    #getComponentType()
  - getCanonicalName
```
public String getCanonicalName()
```
    Equivalent of (@link Class.getCanonicalName().
    
    Specified by:
    
    getCanonicalName in interface JavaParameter
    
    Specified by:
    
    getCanonicalName in interface JavaType
    
    Returns:
    the canonical name of the type, never null
  - getValue
```
public String getValue()
```
    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 aList;      // getValue() will return "List"
 
```
    Specified by:
    
    getValue in interface JavaParameter
    
    Specified by:
    
    getValue in interface JavaType
    
    Returns:
    the value of the type, never null
  - getGenericCanonicalName
```
public String getGenericCanonicalName()
```
    The canonical name with generic information.
    
    Specified by:
    
    getGenericCanonicalName in interface JavaType
    
    Returns:
    the generic canonical name
  - getGenericFullyQualifiedName
```
public String getGenericFullyQualifiedName()
```
    The fully qualified nate with generic information.
    
    Specified by:
    
    getGenericFullyQualifiedName in interface JavaType
    
    Returns:
    the generic fully qualified name
  - getResolvedValue
```
public String getResolvedValue()
```
    Specified by:
    
    getResolvedValue in interface JavaParameter
    
    Returns:
    the resolved value of the type
  - getResolvedFullyQualifiedName
```
public String getResolvedFullyQualifiedName()
```
    Specified by:
    
    getResolvedFullyQualifiedName in interface JavaParameter
    
    Returns:
    the resolved FQN, never null
  - getResolvedGenericValue
```
public String getResolvedGenericValue()
```
    Specified by:
    
    getResolvedGenericValue in interface JavaParameter
    
    Returns:
    the resolved generic value of the type, never null
  - getResolvedGenericFullyQualifiedName
```
public String getResolvedGenericFullyQualifiedName()
```
    Specified by:
    
    getResolvedGenericFullyQualifiedName in interface JavaParameter
    
    Returns:
    the resolved generic FQN, never null
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getGenericValue
```
public String getGenericValue()
```
    A java5+ representation of the class. When including all imports, you should be safe to use this method. Examples:
```
  private String fieldA;           // getValue() will return "String"
  private java.lang.String fieldA; // getValue() will return "java.lang.String"
  private List aList;      // getValue() will return "List"
 
```
    Specified by:
    
    getGenericValue in interface JavaType
    
    Returns:
    the generic name of the class as used in the source
  - toGenericString
```
public String toGenericString()
```
    Specified by:
    
    toGenericString in interface JavaType

Class DefaultJavaParameter

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.thoughtworks.qdox.model.impl.AbstractBaseJavaEntity

Methods inherited from class com.thoughtworks.qdox.model.impl.AbstractJavaModel

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJavaParameter

DefaultJavaParameter

Method Detail

getCodeBlock

setName

getName

getType

getJavaClass

getDeclarator

setDeclarator

getParentClass

isVarArgs

getFullyQualifiedName

getCanonicalName

getValue

getGenericCanonicalName

getGenericFullyQualifiedName

getResolvedValue

getResolvedFullyQualifiedName

getResolvedGenericValue

getResolvedGenericFullyQualifiedName

hashCode

equals

toString

getGenericValue

toGenericString