Top Fields Constructors Methods
io.vertx.codegen

public Class ParamInfo

extends Object
Class Inheritance
Imports
io.vertx.codegen.doc.Text, io.vertx.codegen.format.CamelCase, .Case, io.vertx.codegen.type.ClassKind, .ParameterizedTypeInfo, .TypeInfo

Author
Tim Fox

Field Summary

Modifier and TypeField and Description
pack-priv final Text
pack-priv final int
pack-priv final String
pack-priv final TypeInfo
pack-priv final TypeInfo

Constructor Summary

AccessConstructor and Description
public
ParamInfo(int index, String name, Text description, TypeInfo type)

public
ParamInfo(int index, String name, Text description, TypeInfo type, TypeInfo unresolvedType)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
other
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public Text
public int
public String
public String
getName(Case _case)

public TypeInfo
public TypeInfo
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
public boolean

Returns:

true when the param is nullable
isNullable
()

public Boolean

Returns:

true when the param callback value is nullable: when the parameter type is an handler or an async result handler it returns the nullable boolean of the corresponding parameter, otherwise it returns null
isNullableCallback
()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

descriptionback to summary
pack-priv final Text description
indexback to summary
pack-priv final int index
nameback to summary
pack-priv final String name
typeback to summary
pack-priv final TypeInfo type
unresolvedTypeback to summary
pack-priv final TypeInfo unresolvedType

Constructor Detail

ParamInfoback to summary
public ParamInfo(int index, String name, Text description, TypeInfo type)
ParamInfoback to summary
public ParamInfo(int index, String name, Text description, TypeInfo type, TypeInfo unresolvedType)

Method Detail

equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getDescriptionback to summary
public Text getDescription()
getIndexback to summary
public int getIndex()
getNameback to summary
public String getName()
getNameback to summary
public String getName(Case _case)
getTypeback to summary
public TypeInfo getType()
getUnresolvedTypeback to summary
public TypeInfo getUnresolvedType()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isDataObjectback to summary
public boolean isDataObject()
isNullableback to summary
public boolean isNullable()
Returns:boolean

true when the param is nullable

isNullableCallbackback to summary
public Boolean isNullableCallback()
Returns:Boolean

true when the param callback value is nullable: when the parameter type is an handler or an async result handler it returns the nullable boolean of the corresponding parameter, otherwise it returns null

toStringback 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