Package com.thoughtworks.qdox.model
Class JavaMethodDelegate
java.lang.Object
com.thoughtworks.qdox.model.AbstractBaseJavaEntity
com.thoughtworks.qdox.model.AbstractJavaEntity
com.thoughtworks.qdox.model.AbstractInheritableJavaEntity
com.thoughtworks.qdox.model.JavaMethod
com.thoughtworks.qdox.model.JavaMethodDelegate
- All Implemented Interfaces:
Member,Serializable,Comparable
This class can be used to access overridden methods while keeping a reference to the original class.
This is especially useful when trying to resolve generics
- Since:
- 1.12
- Author:
- Robert Scholte
- See Also:
-
Field Summary
Fields inherited from class com.thoughtworks.qdox.model.AbstractJavaEntity
modifiersFields inherited from class com.thoughtworks.qdox.model.AbstractBaseJavaEntity
name, parent -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddParameter(JavaParameter javaParameter) intbooleangetDeclarationSignature(boolean withModifiers) Type[]Equivalent of java.lang.reflect.Method.getGenericReturnType()intString[]Return list of modifiers as Strings.getName()getNamedParameter(String tagName, String parameterName) Convenience method forgetTagByName(String).getNamedParameter(String)that also checks for null tag.getParameterByName(String name) Type[]Type[]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 typesprotected Type[]getParameterTypes(boolean resolve, JavaClass _callingClass) Not every entity has a parentClass, but AnnotationFieldRef requires access to it.Equivalent of java.lang.reflect.Method.getReturnType()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 typeprotected TypegetReturnType(boolean resolve, JavaClass _callingClass) Get the original source code of the body of this method.getTagByName(String name) getTagByName(String name, boolean inherited) getTags()getTagsByName(String name) getTagsByName(String name, boolean inherited) inthashCode()booleanbooleanbooleanisFinal()booleanisNative()booleanbooleanbooleanbooleanbooleanisPublic()booleanisStatic()booleanbooleanbooleanbooleanbooleanvoidsetAnnotations(Annotation[] annotations) voidsetComment(String comment) voidsetConstructor(boolean constructor) voidsetExceptions(Type[] exceptions) voidsetLineNumber(int lineNumber) voidsetModifiers(String[] modifiers) voidvoidsetParent(JavaClassParent parent) voidsetParentClass(JavaClass parentClass) voidsetReturns(Type returns) Define the return type of this methodvoidsetSourceCode(String sourceCode) voidvoidsetTypeParameters(TypeVariable[] typeParameters) booleansignatureMatches(String name, Type[] parameterTypes) This method is NOT varArg aware.booleansignatureMatches(String name, Type[] parameterTypes, boolean varArg) toString()Methods inherited from class com.thoughtworks.qdox.model.JavaMethod
writeBody, writeBodyMethods inherited from class com.thoughtworks.qdox.model.AbstractJavaEntity
write, writeAccessibilityModifier, writeAllModifiers, writeNonAccessibilityModifiers
-
Constructor Details
-
JavaMethodDelegate
-
-
Method Details
-
getReturnType
Description copied from class:JavaMethodIf a class inherits this method from a generic class or interface, you can use this method to get the resolved return type- Overrides:
getReturnTypein classJavaMethod- Returns:
-
getReturnType
- Overrides:
getReturnTypein classJavaMethod- Returns:
-
getParameterTypes
Description copied from class:JavaMethodIf a class inherits this method from a generic class or interface, you can use this method to get the resolved parameter types- Overrides:
getParameterTypesin classJavaMethod- Returns:
- the parameter types as array
-
getParameterTypes
- Overrides:
getParameterTypesin classJavaMethod
-
addParameter
- Overrides:
addParameterin classJavaMethod
-
compareTo
- Specified by:
compareToin interfaceComparable- Overrides:
compareToin classJavaMethod
-
equals
- Overrides:
equalsin classJavaMethod
-
getAnnotations
- Overrides:
getAnnotationsin classAbstractBaseJavaEntity
-
getCallSignature
- Specified by:
getCallSignaturein interfaceMember- Overrides:
getCallSignaturein classJavaMethod
-
getCodeBlock
- Overrides:
getCodeBlockin classAbstractJavaEntity
-
getComment
- Overrides:
getCommentin classAbstractJavaEntity
-
getDeclarationSignature
- Specified by:
getDeclarationSignaturein interfaceMember- Overrides:
getDeclarationSignaturein classJavaMethod
-
getExceptions
- Overrides:
getExceptionsin classJavaMethod
-
getGenericReturnType
Description copied from class:JavaMethodEquivalent of java.lang.reflect.Method.getGenericReturnType()- Overrides:
getGenericReturnTypein classJavaMethod- Returns:
- the generic returntype
-
getLineNumber
public int getLineNumber()- Overrides:
getLineNumberin classAbstractBaseJavaEntity
-
getModifiers
Description copied from class:AbstractJavaEntityReturn list of modifiers as Strings. (public, private, protected, final, abstract, static)- Overrides:
getModifiersin classAbstractJavaEntity
-
getName
- Overrides:
getNamein classAbstractBaseJavaEntity
-
getNamedParameter
Description copied from class:AbstractJavaEntityConvenience method forgetTagByName(String).getNamedParameter(String)that also checks for null tag.- Overrides:
getNamedParameterin classAbstractJavaEntity
-
getParameterByName
- Overrides:
getParameterByNamein classJavaMethod
-
getParameters
- Overrides:
getParametersin classJavaMethod
-
getParameterTypes
- Overrides:
getParameterTypesin classJavaMethod- Returns:
- the parameter types as array
-
getParent
- Overrides:
getParentin classAbstractBaseJavaEntity- Returns:
-
getParentClass
Description copied from class:AbstractBaseJavaEntityNot every entity has a parentClass, but AnnotationFieldRef requires access to it. When used with JavaClass, don't confuse this with getSuperClass()- Overrides:
getParentClassin classAbstractJavaEntity- Returns:
- the surrounding class
-
getPropertyName
- Overrides:
getPropertyNamein classJavaMethod- Returns:
- the name of the property this method represents, or null if this method is not a property mutator or property accessor.
-
getPropertyType
- Overrides:
getPropertyTypein classJavaMethod- Returns:
- the type of the property this method represents, or null if this method is not a property mutator or property accessor.
-
getReturns
- Overrides:
getReturnsin classJavaMethod- Returns:
- the return type
-
getReturnType
Description copied from class:JavaMethodEquivalent of java.lang.reflect.Method.getReturnType()- Overrides:
getReturnTypein classJavaMethod- Returns:
-
getSource
- Overrides:
getSourcein classAbstractJavaEntity
-
getSourceCode
Description copied from class:JavaMethodGet the original source code of the body of this method.- Overrides:
getSourceCodein classJavaMethod- Returns:
- Code as string.
-
getTagByName
- Overrides:
getTagByNamein classAbstractInheritableJavaEntity
-
getTagByName
- Overrides:
getTagByNamein classAbstractJavaEntity
-
getTags
- Overrides:
getTagsin classAbstractJavaEntity
-
getTagsByName
- Overrides:
getTagsByNamein classJavaMethod
-
getTagsByName
- Overrides:
getTagsByNamein classAbstractJavaEntity
-
getTypeParameters
- Overrides:
getTypeParametersin classJavaMethod
-
hashCode
public int hashCode()- Overrides:
hashCodein classJavaMethod
-
isAbstract
public boolean isAbstract()- Overrides:
isAbstractin classAbstractJavaEntity
-
isConstructor
public boolean isConstructor()- Overrides:
isConstructorin classJavaMethod- Returns:
- true is this method is a constructor
-
isFinal
public boolean isFinal()- Overrides:
isFinalin classAbstractJavaEntity
-
isNative
public boolean isNative()- Overrides:
isNativein classAbstractJavaEntity
-
isPrivate
public boolean isPrivate()- Overrides:
isPrivatein classAbstractJavaEntity
-
isPropertyAccessor
public boolean isPropertyAccessor()- Overrides:
isPropertyAccessorin classJavaMethod- Returns:
- true if this method is a Java Bean accessor
-
isPropertyMutator
public boolean isPropertyMutator()- Overrides:
isPropertyMutatorin classJavaMethod- Returns:
- true if this method is a Java Bean accessor
-
isProtected
public boolean isProtected()- Overrides:
isProtectedin classAbstractJavaEntity
-
isPublic
public boolean isPublic()- Overrides:
isPublicin classJavaMethod
-
isStatic
public boolean isStatic()- Overrides:
isStaticin classAbstractJavaEntity
-
isStrictfp
public boolean isStrictfp()- Overrides:
isStrictfpin classAbstractJavaEntity
-
isSynchronized
public boolean isSynchronized()- Overrides:
isSynchronizedin classAbstractJavaEntity
-
isTransient
public boolean isTransient()- Overrides:
isTransientin classAbstractJavaEntity
-
isVarArgs
public boolean isVarArgs()- Overrides:
isVarArgsin classJavaMethod- Returns:
- true is this method conains varArgs
-
isVolatile
public boolean isVolatile()- Overrides:
isVolatilein classAbstractJavaEntity
-
setAnnotations
- Overrides:
setAnnotationsin classAbstractBaseJavaEntity
-
setComment
- Overrides:
setCommentin classAbstractJavaEntity
-
setConstructor
public void setConstructor(boolean constructor) - Overrides:
setConstructorin classJavaMethod
-
setExceptions
- Overrides:
setExceptionsin classJavaMethod
-
setLineNumber
public void setLineNumber(int lineNumber) - Overrides:
setLineNumberin classAbstractBaseJavaEntity
-
setModifiers
- Overrides:
setModifiersin classAbstractJavaEntity
-
setName
- Overrides:
setNamein classAbstractBaseJavaEntity
-
setParent
- Overrides:
setParentin classAbstractBaseJavaEntity
-
setParentClass
- Overrides:
setParentClassin classAbstractJavaEntity
-
setReturns
Description copied from class:JavaMethodDefine the return type of this method- Overrides:
setReturnsin classJavaMethod- Parameters:
returns- the return type
-
setSourceCode
- Overrides:
setSourceCodein classJavaMethod
-
setTags
- Overrides:
setTagsin classAbstractJavaEntity
-
setTypeParameters
- Overrides:
setTypeParametersin classJavaMethod
-
signatureMatches
- Overrides:
signatureMatchesin classJavaMethod- Parameters:
name- method nameparameterTypes- parameter types or null if there are no parameters.- Returns:
- true if the signature and parameters match.
-
signatureMatches
Description copied from class:JavaMethodThis method is NOT varArg aware. The overloaded method is.- Overrides:
signatureMatchesin classJavaMethod- Returns:
-
toString
- Overrides:
toStringin classJavaMethod
-