JavaMethod (QDox 2.0-M3 API)

All Superinterfaces:

JavaAnnotatedElement, JavaGenericDeclaration, JavaMember, JavaModel, ParameterDeclarator, Serializable

All Known Implementing Classes:

DefaultJavaMethod, JavaMethodDelegate
```
public interface JavaMethod
extends JavaAnnotatedElement, JavaMember, JavaModel, JavaGenericDeclaration, ParameterDeclarator
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getCallSignature()`
`String`	`getDeclarationSignature(boolean withModifiers)`
`List<JavaClass>`	`getExceptions()`
`List<JavaType>`	`getExceptionTypes()`
`JavaClass`	`getGenericReturnType()` Deprecated. use `getReturnType()` instead, this one holds generic information
`JavaParameter`	`getParameterByName(String name)`
`List<JavaParameter>`	`getParameters()`
`List<JavaType>`	`getParameterTypes()`
`List<JavaType>`	`getParameterTypes(boolean resolve)` If a class inherits this method from a generic class or interface, you can use this method to get the resolved parameter types
`JavaClass`	`getParentClass()` Deprecated. use `JavaMember.getDeclaringClass()` instead
`String`	`getPropertyName()`
`JavaType`	`getPropertyType()`
`JavaClass`	`getReturns()`
`JavaType`	`getReturnType()` Equivalent of java.lang.reflect.Method.getReturnType()
`JavaType`	`getReturnType(boolean resolve)` If a class inherits this method from a generic class or interface, you can use this method to get the resolved return type
`String`	`getSourceCode()` Get the original source code of the body of this method.
`DocletTag`	`getTagByName(String string, boolean b)`
`List<DocletTag>`	`getTagsByName(String name, boolean inherited)`
`boolean`	`isDefault()` Equivalent `Method.isDefault()`
`boolean`	`isPropertyAccessor()` Returns `true` if this method follows the bean convention of being an accessor.
`boolean`	`isPropertyMutator()` Returns `true` if this method follows the bean convention of being an mutator.
`boolean`	`isVarArgs()` Equivalent of `Method.isVarArgs()`
`boolean`	`signatureMatches(String name, List<JavaType> parameterTypes)` This method is NOT varArg aware.
`boolean`	`signatureMatches(String name, List<JavaType> parameterTypes, boolean varArg)`

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

Methods inherited from interface com.thoughtworks.qdox.model.JavaMember
getDeclaringClass, getModifiers, getName, isAbstract, isFinal, isNative, isPrivate, isProtected, isPublic, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile

Methods inherited from interface com.thoughtworks.qdox.model.JavaModel
getCodeBlock, getLineNumber, getSource

Methods inherited from interface com.thoughtworks.qdox.model.JavaGenericDeclaration
getTypeParameters

- Method Detail
  - getGenericReturnType
```
JavaClass getGenericReturnType()
```
    Deprecated. use getReturnType() instead, this one holds generic information
    
    Equivalent of java.lang.reflect.Method.getGenericReturnType()
    
    Returns:
    
    the generic return type
    
    Since:
    
    1.12
  - getParentClass
```
JavaClass getParentClass()
```
    Deprecated. use JavaMember.getDeclaringClass() instead
    
    Specified by:
    
    getParentClass in interface ParameterDeclarator
  - getReturns
```
JavaClass getReturns()
```
    Returns:
    
    the return type
  - getParameters
```
List<JavaParameter> getParameters()
```
  - getParameterByName
```
JavaParameter getParameterByName(String name)
```
  - getExceptions
```
List<JavaClass> getExceptions()
```
  - getExceptionTypes
```
List<JavaType> getExceptionTypes()
```
  - isVarArgs
```
boolean isVarArgs()
```
    Equivalent of Method.isVarArgs()
    
    Returns:
    
    true if this method was declared to take a variable number of arguments, otherwise false
  - getDeclarationSignature
```
String getDeclarationSignature(boolean withModifiers)
```
    Since:
    
    1.3
  - getCallSignature
```
String getCallSignature()
```
    Since:
    
    1.3
  - signatureMatches
```
boolean signatureMatches(String name,
                         List<JavaType> parameterTypes)
```
    This method is NOT varArg aware.
    
    Parameters:
    
    name - the name of the method
    
    parameterTypes - the parameter types of the method, can be null
    
    Returns:
    
    true if this method matches the signature, otherwise false
  - signatureMatches
```
boolean signatureMatches(String name,
                         List<JavaType> parameterTypes,
                         boolean varArg)
```
    Parameters:
    
    name - the name of the method
    
    parameterTypes - the parameter types, can be null
    
    varArg - true is signature should match a varArg-method, otherwise false
    
    Returns:
    
    true if this method matches the signature, otherwise false
  - isPropertyAccessor
```
boolean isPropertyAccessor()
```
    Returns true if this method follows the bean convention of being an accessor.
```
   public String getName();             // true
   public boolean isValid()             // true
   public String getName( String def ); // false, it has a parameter
   public String gettingUp();           // false, 'get' is not followed by an uppercase character
   public boolean isolate();            // false, 'is' is not followed by an uppercase character
   public static String getName();      // false, it is static
 
```
    Returns:
    
    true if this method is a Java Bean accessor, otherwise false
    
    Since:
    
    1.3
  - isPropertyMutator
```
boolean isPropertyMutator()
```
    Returns true if this method follows the bean convention of being an mutator.
```
  public void setName(String name);        // true
  public void setUp();                     // false, it has no parameter
  public void settingUp(String def);       // false, 'set' is not followed by an uppercase character
  public static void setName(String name); // false, it is static
 
```
    Returns:
    
    true if this method is a Java Bean mutator, otherwise false
    
    Since:
    
    1.3
  - getPropertyType
```
JavaType getPropertyType()
```
    Returns:
    
    the type of the property this method represents, or null if this method is not a property mutator or property accessor.
    
    Since:
    
    1.3
  - getPropertyName
```
String getPropertyName()
```
    Returns:
    
    the name of the property this method represents, or null if this method is not a property mutator or property accessor.
    
    Since:
    
    1.3
  - getTagsByName
```
List<DocletTag> getTagsByName(String name,
                              boolean inherited)
```
  - getSourceCode
```
String getSourceCode()
```
    Get the original source code of the body of this method.
    
    Returns:
    
    Code as string.
  - getReturnType
```
JavaType getReturnType()
```
    Equivalent of java.lang.reflect.Method.getReturnType()
    
    Returns:
    
    the return type
    
    Since:
    
    1.12
  - getReturnType
```
JavaType getReturnType(boolean resolve)
```
    If a class inherits this method from a generic class or interface, you can use this method to get the resolved return type
    
    Parameters:
    
    resolve - define if generic should be resolved
    
    Returns:
    
    the return type
    
    Since:
    
    1.12
  - getParameterTypes
```
List<JavaType> getParameterTypes()
```
    Returns:
    
    the parameter types
    
    Since:
    
    1.12
  - getParameterTypes
```
List<JavaType> getParameterTypes(boolean resolve)
```
    If a class inherits this method from a generic class or interface, you can use this method to get the resolved parameter types
    
    Parameters:
    
    resolve -
    
    Returns:
    
    the parameter types
    
    Since:
    
    1.12
  - getTagByName
```
DocletTag getTagByName(String string,
                       boolean b)
```
  - isDefault
```
boolean isDefault()
```
    Equivalent Method.isDefault()
    
    Returns:
    
    true if this is a default method of an interface, otherwise false
    
    Since:
    
    2.0

Interface JavaMethod

Method Summary

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

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

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

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

Method Detail

getGenericReturnType

getParentClass

getReturns

getParameters

getParameterByName

getExceptions

getExceptionTypes

isVarArgs

getDeclarationSignature

getCallSignature

signatureMatches

signatureMatches

isPropertyAccessor

isPropertyMutator

getPropertyType

getPropertyName

getTagsByName

getSourceCode

getReturnType

getReturnType

getParameterTypes

getParameterTypes

getTagByName

isDefault