io.vertx.codegen

Class MethodInfo

java.lang.Object

io.vertx.codegen.MethodInfo

All Implemented Interfaces:

Comparable<MethodInfo>

Direct Known Subclasses:

ProxyMethodInfo

public class MethodInfo
extends Object
implements Comparable<MethodInfo>

Author:

Tim Fox

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	collectImports(Collection<ClassTypeInfo> imports)
int	compareTo(MethodInfo o)
String	getComment()
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	isDefaultMethod()
boolean	isFluent()
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()
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)
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,
                  MethodKind kind,
                  TypeInfo returnType,
                  Text returnDescription,
                  boolean fluent,
                  boolean cacheReturn,
                  List<ParamInfo> params,
                  String comment,
                  Doc doc,
                  boolean staticMethod,
                  boolean defaultMethod,
                  List<TypeParamInfo.Method> typeParams)

Method Detail

getName

public String getName()

getName

public String getName(Case _case)

getKind

public MethodKind getKind()

getReturnType

public TypeInfo getReturnType()

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()

getOwnerTypes

public Set<ClassTypeInfo> getOwnerTypes()

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()

isCacheReturn

public boolean isCacheReturn()

isNullableReturn

public boolean isNullableReturn()

Returns:

true if the method has a nullable return

getParams

public List<ParamInfo> getParams()

getParam

public ParamInfo getParam(int index)

getComment

public String getComment()

getDoc

public Doc getDoc()

isStaticMethod

public boolean isStaticMethod()

isDefaultMethod

public boolean isDefaultMethod()

getTypeParams

public List<TypeParamInfo.Method> getTypeParams()

mergeTypeParams

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

Throws:

IllegalArgumentException

collectImports

public void collectImports(Collection<ClassTypeInfo> imports)

compareTo

public int compareTo(MethodInfo o)

Specified by:

compareTo in interface Comparable<MethodInfo>

toString

public String toString()

Overrides:

toString in class Object