com.thoughtworks.qdox.model.impl

Class DefaultJavaExecutable

java.lang.Object

com.thoughtworks.qdox.model.impl.AbstractJavaModel

com.thoughtworks.qdox.model.impl.AbstractBaseJavaEntity

com.thoughtworks.qdox.model.impl.AbstractJavaEntity

com.thoughtworks.qdox.model.impl.AbstractInheritableJavaEntity

com.thoughtworks.qdox.model.impl.DefaultJavaExecutable

All Implemented Interfaces:

JavaAnnotatedElement, JavaExecutable, JavaGenericDeclaration, JavaMember, JavaModel, Serializable

Direct Known Subclasses:

DefaultJavaConstructor, DefaultJavaMethod

public abstract class DefaultJavaExecutable
extends AbstractInheritableJavaEntity
implements JavaExecutable

The BaseMethod contains all methods used by both JavaMethod and JavaConstructor

Author:

Robert Scholte

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultJavaExecutable()

Method Summary

Modifier and Type	Method and Description
String	getCallSignature()
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
protected JavaType	getReturns()
protected String	getSignature(boolean withModifiers, boolean isDeclaration)
String	getSourceCode() Get the original source code of the body of this method.
List<DocletTag>	getTagsByName(String name, boolean inherited)
boolean	isPublic() Equivalent of Modifier.isPublic(int)
boolean	isVarArgs() Equivalent of Executable.isVarArgs()
void	setExceptions(List<JavaClass> exceptions)
void	setParameters(List<JavaParameter> javaParameters)
void	setSourceCode(String sourceCode)
protected boolean	signatureMatches(List<JavaType> parameterTypes, boolean varArgs)

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

getTagByName

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

getDeclaringClass, getModifiers, getName, isAbstract, isFinal, isNative, isPrivate, isProtected, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile, setDeclaringClass, setModifiers, setName

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

getAnnotations, getComment, getNamedParameter, getSource, getTagByName, getTags, getTagsByName, setAnnotations, setComment, setSource, setTags

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

getLineNumber, getModelWriter, setLineNumber, setModelWriterFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getDeclaringClass

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, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile

Constructor Detail

DefaultJavaExecutable

public DefaultJavaExecutable()

Method Detail

getParameters

public List<JavaParameter> getParameters()

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

Specified by:

getParameters in interface JavaExecutable

Returns:

a list of JavaParameters, never null

getParameterByName

public JavaParameter getParameterByName(String name)

Specified by:

getParameterByName in interface JavaExecutable

Parameters:

name - the name of the parameter

Returns:

the JavaParameter matching the name, otherwise null

getExceptions

public List<JavaClass> getExceptions()

Equivalent of Executable.getExceptionTypes()

Specified by:

getExceptions in interface JavaExecutable

Returns:

a list of Exceptions, never null

getExceptionTypes

public List<JavaType> getExceptionTypes()

Specified by:

getExceptionTypes in interface JavaExecutable

isVarArgs

public boolean isVarArgs()

Equivalent of Executable.isVarArgs()

Specified by:

isVarArgs in interface JavaExecutable

Returns:

true if the final parameter is a varArg, otherwise false

setParameters

public void setParameters(List<JavaParameter> javaParameters)

setExceptions

public void setExceptions(List<JavaClass> exceptions)

signatureMatches

protected boolean signatureMatches(List<JavaType> parameterTypes,
                                   boolean varArgs)

isPublic

public boolean isPublic()

Equivalent of Modifier.isPublic(int)

Specified by:

isPublic in interface JavaMember

Overrides:

isPublic in class AbstractJavaEntity

Returns:

true if entity is public, otherwise false

getTagsByName

public List<DocletTag> getTagsByName(String name,
                                     boolean inherited)

Specified by:

getTagsByName in class AbstractInheritableJavaEntity

getParameterTypes

public List<JavaType> getParameterTypes()

Equivalent of Executable.getParameterTypes()

Specified by:

getParameterTypes in interface JavaExecutable

Returns:

a list of JavaParameters, never null

getParameterTypes

public 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

Specified by:

getParameterTypes in interface JavaExecutable

Parameters:

resolve - true if the resolved types should be returned, otherwise false

Returns:

the parameter types

getSourceCode

public String getSourceCode()

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

Specified by:

getSourceCode in interface JavaExecutable

Returns:

Code as string.

setSourceCode

public void setSourceCode(String sourceCode)

getCallSignature

public String getCallSignature()

Specified by:

getCallSignature in interface JavaExecutable

getReturns

protected JavaType getReturns()

getSignature

protected String getSignature(boolean withModifiers,
                              boolean isDeclaration)

Since:

1.3