dev.gradleplugins.documentationkit.dsl.source.model

Class MethodMetaData

java.lang.Object

dev.gradleplugins.documentationkit.dsl.source.model.AbstractLanguageElement

dev.gradleplugins.documentationkit.dsl.source.model.MethodMetaData

All Implemented Interfaces:

LanguageElement, TypeContainer, java.io.Serializable

public class MethodMetaData
extends AbstractLanguageElement
implements java.io.Serializable, TypeContainer

Static meta-data about a method extracted from the source for the class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MethodMetaData(java.lang.String name, ClassMetaData ownerClass)

Method Summary

Modifier and Type	Method and Description
ParameterMetaData	addParameter(java.lang.String name, TypeMetaData type)
boolean	equals(java.lang.Object o)
java.lang.String	getName()
MethodMetaData	getOverriddenMethod()
java.lang.String	getOverrideSignature() Returns the signature of this method, excluding the return type, and converting generic types to their raw types.
ClassMetaData	getOwnerClass()
java.util.List<ParameterMetaData>	getParameters()
TypeMetaData	getReturnType()
java.lang.String	getSignature()
int	hashCode()
void	setReturnType(TypeMetaData returnType)
java.lang.String	toString()
void	visitTypes(org.gradle.api.Action<TypeMetaData> action)

Methods inherited from class dev.gradleplugins.documentationkit.dsl.source.model.AbstractLanguageElement

addAnnotationTypeName, getAnnotationTypeNames, getRawCommentText, getReplacement, isDeprecated, isIncubating, isReplaced, resolveTypes, setRawCommentText, setReplacement

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MethodMetaData

public MethodMetaData(java.lang.String name,
                      ClassMetaData ownerClass)

Method Detail

getName

public java.lang.String getName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class AbstractLanguageElement

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractLanguageElement

getOwnerClass

public ClassMetaData getOwnerClass()

getReturnType

public TypeMetaData getReturnType()

setReturnType

public void setReturnType(TypeMetaData returnType)

getOverriddenMethod

public MethodMetaData getOverriddenMethod()

getParameters

public java.util.List<ParameterMetaData> getParameters()

addParameter

public ParameterMetaData addParameter(java.lang.String name,
                                      TypeMetaData type)

getSignature

public java.lang.String getSignature()

getOverrideSignature

public java.lang.String getOverrideSignature()

Returns the signature of this method, excluding the return type, and converting generic types to their raw types.

visitTypes

public void visitTypes(org.gradle.api.Action<TypeMetaData> action)

Specified by:

visitTypes in interface TypeContainer