com.thoughtworks.qdox.model

Interface JavaExecutable

All Superinterfaces:

JavaAnnotatedElement, JavaGenericDeclaration, JavaMember, JavaModel, Serializable

All Known Subinterfaces:

JavaConstructor, JavaMethod

All Known Implementing Classes:

DefaultJavaConstructor, DefaultJavaExecutable, DefaultJavaMethod, JavaMethodDelegate

public interface JavaExecutable
extends JavaAnnotatedElement, JavaGenericDeclaration, JavaMember

A shared interface for the common functionality of Method and Constructor.

Since:

2.0

Author:

Robert Scholte

See Also:

Executable

Method Summary

Modifier and Type	Method and Description
String	getCallSignature()
JavaClass	getDeclaringClass() Equivalent of Member.getDeclaringClass()
List<JavaClass>	getExceptions() Equivalent of Executable.getExceptionTypes()
List<JavaType>	getExceptionTypes()
JavaParameter	getParameterByName(String name)
List<JavaParameter>	getParameters() Equivalent of Executable.getParameterTypes(), where a JavaParameter also contains the original name if available.
List<JavaType>	getParameterTypes() Equivalent of Executable.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
String	getSourceCode() Get the original source code of the body of this method.
boolean	isVarArgs() Equivalent of Executable.isVarArgs()

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.JavaGenericDeclaration

getTypeParameters

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

getModifiers, getName, isAbstract, isFinal, isNative, isPrivate, isProtected, isPublic, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile

Method Detail

getDeclaringClass

JavaClass getDeclaringClass()

Description copied from interface: JavaMember

Equivalent of Member.getDeclaringClass()

Specified by:

getDeclaringClass in interface JavaMember

Returns:

the declaring class

getExceptions

List<JavaClass> getExceptions()

Equivalent of Executable.getExceptionTypes()

Returns:

a list of Exceptions, never null

getExceptionTypes

List<JavaType> getExceptionTypes()

getParameterByName

JavaParameter getParameterByName(String name)

Parameters:

name - the name of the parameter

Returns:

the JavaParameter matching the name, otherwise null

getParameters

List<JavaParameter> getParameters()

Equivalent of Executable.getParameterTypes(), where a JavaParameter also contains the original name if available.

Returns:

a list of JavaParameters, never null

getParameterTypes

List<JavaType> getParameterTypes()

Equivalent of Executable.getParameterTypes()

Returns:

a list of JavaParameters, never null

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 - true if the resolved types should be returned, otherwise false

Returns:

the parameter types

Since:

1.12

getSourceCode

String getSourceCode()

Get the original source code of the body of this method.

Returns:

Code as string.

isVarArgs

boolean isVarArgs()

Equivalent of Executable.isVarArgs()

Returns:

true if the final parameter is a varArg, otherwise false

getCallSignature

String getCallSignature()