Vert.x 4.5.13 · io.vertx.codegen.MethodInfo · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private boolean	cacheReturn
private String	comment
private boolean	defaultMethod
private boolean	deprecated
private Text	deprecatedDesc
private Doc	doc
private boolean	fluent
private boolean	methodOverride
private String	name
private Set<ClassTypeInfo>	ownerTypes
private List<ParamInfo>	params
private Text	returnDescription
private TypeInfo	returnType
private boolean	staticMethod
private List<TypeParamInfo.Method>	typeParams
private boolean	useFutures

Access	Constructor and Description
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 Summary

Modifier and Type	Method and Description
public void	collectImports(Collection<ClassTypeInfo> imports)
public int	compareTo(MethodInfo the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
private static boolean	containsAnyJavaType(TypeInfo type)
public MethodInfo	Returns: a copy of this object copy()
public TypeInfo	Returns: the callback type or `null` when the method is not a callback method getCallbackType()
public String	getComment()
public Text	Returns: the description of deprecated getDeprecatedDesc()
public Doc	getDoc()
public MethodKind	getKind()
public String	getName()
public String	getName(Case _case)
public Set<ClassTypeInfo>	getOwnerTypes()
public ParamInfo	getParam(int index)
public List<ParamInfo>	getParams()
public Text	getReturnDescription()
public TypeInfo	getReturnType()
public Signature	Returns: the method signature getSignature() Returns the method signature, the returned object is freely modifiable.
public List<TypeParamInfo.Method>	getTypeParams()
public boolean	isCacheReturn()
public boolean	Returns: whether the method is annotated with `io.vertx.codegen.annotations.GenIgnore` isContainingAnyJavaType()
public boolean	isDefaultMethod()
public boolean	Returns: `true` if the method has a `@Deprecated` annotation isDeprecated()
public boolean	isFluent()
public boolean	isMethodOverride()
public boolean	Returns: true if the method has a nullable return isNullableReturn()
public boolean	Returns: true when this method is owned by the `owner` argument isOwnedBy(ClassTypeInfo the tested type 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.
public boolean	isStaticMethod()
public boolean	isUseFutures()
public void	mergeTypeParams(List<TypeParamInfo.Method> mergedTypeParams)
public ParamInfo	Returns: the matching method parameter or null resolveClassTypeParam(TypeVariableInfo the type variable to check 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.
public TypeArgExpression	resolveTypeArg(TypeVariableInfo typeVar)
public MethodInfo	setCacheReturn(boolean cacheReturn)
public MethodInfo	setComment(String comment)
public MethodInfo	setDefaultMethod(boolean defaultMethod)
public MethodInfo	setDeprecated(boolean deprecated)
public MethodInfo	setDeprecatedDesc(Text deprecatedDesc)
public MethodInfo	setDoc(Doc doc)
public MethodInfo	setFluent(boolean fluent)
public MethodInfo	setName(String name)
public MethodInfo	setOwnerTypes(Set<ClassTypeInfo> ownerTypes)
public MethodInfo	setParams(List<ParamInfo> params)
public MethodInfo	setReturnDescription(Text returnDescription)
public MethodInfo	setReturnType(TypeInfo returnType)
public MethodInfo	setStaticMethod(boolean staticMethod)
public MethodInfo	setTypeParams(List<TypeParamInfo.Method> typeParams)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

cacheReturn	back to summary
private boolean cacheReturn

comment	back to summary
private String comment

defaultMethod	back to summary
private boolean defaultMethod

deprecated	back to summary
private boolean deprecated

deprecatedDesc	back to summary
private Text deprecatedDesc

doc	back to summary
private Doc doc

fluent	back to summary
private boolean fluent

methodOverride	back to summary
private boolean methodOverride

name	back to summary
private String name

ownerTypes	back to summary
private Set<ClassTypeInfo> ownerTypes

params	back to summary
private List<ParamInfo> params

returnDescription	back to summary
private Text returnDescription

returnType	back to summary
private TypeInfo returnType

staticMethod	back to summary
private boolean staticMethod

typeParams	back to summary
private List<TypeParamInfo.Method> typeParams

useFutures	back to summary
private boolean useFutures

MethodInfo	back to summary
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

collectImports	back to summary
public void collectImports(Collection<ClassTypeInfo> imports)

compareTo back to summary

compareTo	back to summary
public int compareTo(MethodInfo o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters o:MethodInfo the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(MethodInfo o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:MethodInfo: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

containsAnyJavaType	back to summary
private static boolean containsAnyJavaType(TypeInfo type)

copy	back to summary
public MethodInfo copy() Returns:MethodInfo a copy of this object

getCallbackType	back to summary
public TypeInfo getCallbackType() Returns:TypeInfo the callback type or `null` when the method is not a callback method

getComment	back to summary
public String getComment()

getDeprecatedDesc	back to summary
public Text getDeprecatedDesc() Returns:Text the description of deprecated

getDoc	back to summary
public Doc getDoc()

getKind	back to summary
public MethodKind getKind()

getName	back to summary
public String getName()

getName	back to summary
public String getName(Case _case)

getOwnerTypes	back to summary
public Set<ClassTypeInfo> getOwnerTypes()

getParam	back to summary
public ParamInfo getParam(int index)

getParams	back to summary
public List<ParamInfo> getParams()

getReturnDescription	back to summary
public Text getReturnDescription()

getReturnType	back to summary
public TypeInfo getReturnType()

getSignature	back to summary
public Signature getSignature() Returns the method signature, the returned object is freely modifiable. Returns:Signature the method signature

getSignature

back to summary

public Signature getSignature()

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

Returns:Signature: the method signature

getTypeParams	back to summary
public List<TypeParamInfo.Method> getTypeParams()

isCacheReturn	back to summary
public boolean isCacheReturn()

isContainingAnyJavaType	back to summary
public boolean isContainingAnyJavaType() Returns:boolean whether the method is annotated with `io.vertx.codegen.annotations.GenIgnore`

isDefaultMethod	back to summary
public boolean isDefaultMethod()

isDeprecated	back to summary
public boolean isDeprecated() Returns:boolean `true` if the method has a `@Deprecated` annotation

isFluent	back to summary
public boolean isFluent()

isMethodOverride	back to summary
public boolean isMethodOverride()

isNullableReturn	back to summary
public boolean isNullableReturn() Returns:boolean true if the method has a nullable return

isOwnedBy back to summary

isOwnedBy	back to summary
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:ClassTypeInfo the tested type Returns:boolean true when this method is owned by the `owner` argument

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:ClassTypeInfo: the tested type

Returns:boolean

true when this method is owned by the owner argument

isStaticMethod	back to summary
public boolean isStaticMethod()

isUseFutures	back to summary
public boolean isUseFutures()

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

resolveClassTypeParam back to summary

resolveClassTypeParam	back to summary
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:TypeVariableInfo the type variable to check Returns:ParamInfo the matching method parameter or null

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:TypeVariableInfo: the type variable to check

Returns:ParamInfo

the matching method parameter or null

resolveTypeArg	back to summary
public TypeArgExpression resolveTypeArg(TypeVariableInfo typeVar)

setCacheReturn	back to summary
public MethodInfo setCacheReturn(boolean cacheReturn)

setComment	back to summary
public MethodInfo setComment(String comment)

setDefaultMethod	back to summary
public MethodInfo setDefaultMethod(boolean defaultMethod)

setDeprecated	back to summary
public MethodInfo setDeprecated(boolean deprecated)

setDeprecatedDesc	back to summary
public MethodInfo setDeprecatedDesc(Text deprecatedDesc)

setDoc	back to summary
public MethodInfo setDoc(Doc doc)

setFluent	back to summary
public MethodInfo setFluent(boolean fluent)

setName	back to summary
public MethodInfo setName(String name)

setOwnerTypes	back to summary
public MethodInfo setOwnerTypes(Set<ClassTypeInfo> ownerTypes)

setParams	back to summary
public MethodInfo setParams(List<ParamInfo> params)

setReturnDescription	back to summary
public MethodInfo setReturnDescription(Text returnDescription)

setReturnType	back to summary
public MethodInfo setReturnType(TypeInfo returnType)

setStaticMethod	back to summary
public MethodInfo setStaticMethod(boolean staticMethod)

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

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class MethodInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail