io.vertx.codegen

Class MethodInfo

java.lang.Object

io.vertx.codegen.MethodInfo

All Implemented Interfaces:

Comparable<MethodInfo>

public class MethodInfo
extends Object
implements Comparable<MethodInfo>

Author:

Tim Fox

Constructor Summary

Constructors

Constructor and Description
MethodInfo(Set<ClassTypeInfo> ownerTypes, String name, TypeInfo returnType, Text returnDescription, boolean fluent, boolean cacheReturn, List<ParamInfo> params, String comment, Doc doc, boolean staticMethod, boolean defaultMethod, List<TypeParamInfo.Method> typeParams, boolean deprecated, Text deprecatedDesc, boolean useFutures, boolean methodOverride)

Method Summary

Modifier and Type	Method and Description
void	collectImports(Collection<ClassTypeInfo> imports)
int	compareTo(MethodInfo o)
MethodInfo	copy()
TypeInfo	getCallbackType()
String	getComment()
Text	getDeprecatedDesc()
Doc	getDoc()
MethodKind	getKind()
String	getName()
String	getName(Case _case)
Set<ClassTypeInfo>	getOwnerTypes()
ParamInfo	getParam(int index)
List<ParamInfo>	getParams()
Text	getReturnDescription()
TypeInfo	getReturnType()
Signature	getSignature() Returns the method signature, the returned object is freely modifiable.
List<TypeParamInfo.Method>	getTypeParams()
boolean	isCacheReturn()
boolean	isContainingAnyJavaType()
boolean	isDefaultMethod()
boolean	isDeprecated()
boolean	isFluent()
boolean	isMethodOverride()
boolean	isNullableReturn()
boolean	isOwnedBy(ClassTypeInfo owner) Return true if the provided type is the sole owner of this method, i.e this method is only declared by the provided type.
boolean	isStaticMethod()
boolean	isUseFutures()
void	mergeTypeParams(List<TypeParamInfo.Method> mergedTypeParams)
ParamInfo	resolveClassTypeParam(TypeVariableInfo typeVar) Resolve the method parameter that is of kind ClassKind.CLASS_TYPE and that matches the specified type variable e.g: <U> Map.Entry<String, U> getEntry(String s, Class<U> type); returns for <U> the second method parameter.
TypeArgExpression	resolveTypeArg(TypeVariableInfo typeVar)
MethodInfo	setCacheReturn(boolean cacheReturn)
MethodInfo	setComment(String comment)
MethodInfo	setDefaultMethod(boolean defaultMethod)
MethodInfo	setDeprecated(boolean deprecated)
MethodInfo	setDeprecatedDesc(Text deprecatedDesc)
MethodInfo	setDoc(Doc doc)
MethodInfo	setFluent(boolean fluent)
MethodInfo	setName(String name)
MethodInfo	setOwnerTypes(Set<ClassTypeInfo> ownerTypes)
MethodInfo	setParams(List<ParamInfo> params)
MethodInfo	setReturnDescription(Text returnDescription)
MethodInfo	setReturnType(TypeInfo returnType)
MethodInfo	setStaticMethod(boolean staticMethod)
MethodInfo	setTypeParams(List<TypeParamInfo.Method> typeParams)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodInfo

public MethodInfo(Set<ClassTypeInfo> ownerTypes,
                  String name,
                  TypeInfo returnType,
                  Text returnDescription,
                  boolean fluent,
                  boolean cacheReturn,
                  List<ParamInfo> params,
                  String comment,
                  Doc doc,
                  boolean staticMethod,
                  boolean defaultMethod,
                  List<TypeParamInfo.Method> typeParams,
                  boolean deprecated,
                  Text deprecatedDesc,
                  boolean useFutures,
                  boolean methodOverride)

Method Detail

getName

public String getName()

setName

public MethodInfo setName(String name)

getName

public String getName(Case _case)

getCallbackType

public TypeInfo getCallbackType()

Returns:

the callback type or null when the method is not a callback method

getKind

public MethodKind getKind()

getReturnType

public TypeInfo getReturnType()

setReturnType

public MethodInfo setReturnType(TypeInfo returnType)

isContainingAnyJavaType

public boolean isContainingAnyJavaType()

Returns:

whether the method is annotated with GenIgnore

resolveClassTypeParam

public ParamInfo resolveClassTypeParam(TypeVariableInfo typeVar)

Resolve the method parameter that is of kind ClassKind.CLASS_TYPE and that matches the specified type variable e.g:

<U> Map.Entry<String, U> getEntry(String s, Class<U> type);

returns for <U> the second method parameter.

Parameters:

typeVar - the type variable to check

Returns:

the matching method parameter or null

resolveTypeArg

public TypeArgExpression resolveTypeArg(TypeVariableInfo typeVar)

getReturnDescription

public Text getReturnDescription()

setReturnDescription

public MethodInfo setReturnDescription(Text returnDescription)

getOwnerTypes

public Set<ClassTypeInfo> getOwnerTypes()

setOwnerTypes

public MethodInfo setOwnerTypes(Set<ClassTypeInfo> ownerTypes)

getSignature

public Signature getSignature()

Returns the method signature, the returned object is freely modifiable.

Returns:

the method signature

isOwnedBy

public boolean isOwnedBy(ClassTypeInfo owner)

Return true if the provided type is the sole owner of this method, i.e this method is only declared by the provided type.

Parameters:

owner - the tested type

Returns:

true when this method is owned by the owner argument

isFluent

public boolean isFluent()

setFluent

public MethodInfo setFluent(boolean fluent)

isCacheReturn

public boolean isCacheReturn()

setCacheReturn

public MethodInfo setCacheReturn(boolean cacheReturn)

isNullableReturn

public boolean isNullableReturn()

Returns:

true if the method has a nullable return

getParams

public List<ParamInfo> getParams()

setParams

public MethodInfo setParams(List<ParamInfo> params)

getParam

public ParamInfo getParam(int index)

getComment

public String getComment()

setComment

public MethodInfo setComment(String comment)

getDoc

public Doc getDoc()

setDoc

public MethodInfo setDoc(Doc doc)

isStaticMethod

public boolean isStaticMethod()

setStaticMethod

public MethodInfo setStaticMethod(boolean staticMethod)

isDefaultMethod

public boolean isDefaultMethod()

setDefaultMethod

public MethodInfo setDefaultMethod(boolean defaultMethod)

isDeprecated

public boolean isDeprecated()

Returns:

true if the method has a @Deprecated annotation

setDeprecated

public MethodInfo setDeprecated(boolean deprecated)

isUseFutures

public boolean isUseFutures()

isMethodOverride

public boolean isMethodOverride()

getDeprecatedDesc

public Text getDeprecatedDesc()

Returns:

the description of deprecated

setDeprecatedDesc

public MethodInfo setDeprecatedDesc(Text deprecatedDesc)

getTypeParams

public List<TypeParamInfo.Method> getTypeParams()

setTypeParams

public MethodInfo setTypeParams(List<TypeParamInfo.Method> typeParams)

mergeTypeParams

public void mergeTypeParams(List<TypeParamInfo.Method> mergedTypeParams)
                     throws IllegalArgumentException

Throws:

IllegalArgumentException

collectImports

public void collectImports(Collection<ClassTypeInfo> imports)

copy

public MethodInfo copy()

Returns:

a copy of this object

compareTo

public int compareTo(MethodInfo o)

Specified by:

compareTo in interface Comparable<MethodInfo>

toString

public String toString()

Overrides:

toString in class Object