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

Modifier and Type	Field and Description
pack-priv final DataObjectInfo	dataObject
pack-priv final ClassKind	kind
pack-priv final ModuleInfo	module
pack-priv final String	name
pack-priv final boolean	nullable
pack-priv final String	packageName
pack-priv final List<TypeParamInfo.Class>	params
pack-priv static final HashMap<String, ClassTypeInfo>	PRIMITIVES
pack-priv final String	simpleName

Access	Constructor and Description
public	ClassTypeInfo(ClassKind kind, String name, ModuleInfo module, boolean nullable, List<TypeParamInfo.Class> params, DataObjectInfo dataObject)

Method Summary

Modifier and Type	Method and Description
public void	collectImports(Collection<ClassTypeInfo> the imports imports) Overrides io.vertx.codegen.type.TypeInfo.collectImports. Collect the import fqcn needed by this type.
public boolean	equals(Object the reference object with which to compare. obj) Implements abstract io.vertx.codegen.type.TypeInfo.equals. Indicates whether some other object is "equal to" this one.
public String	format(boolean true when class fqcn should be used, otherwise simple names will be used qualified) Implements abstract io.vertx.codegen.type.TypeInfo.format. Renders the type name.
public DataObjectInfo	getDataObject() Overrides io.vertx.codegen.type.TypeInfo.getDataObject.
public ClassKind	getKind() Implements abstract io.vertx.codegen.type.TypeInfo.getKind.
public ModuleInfo	Returns: the optional module name only present for `io.vertx.codegen.annotations.VertxGen` annotated types. getModule()
public String	Returns: the optional module name only present for `io.vertx.codegen.annotations.VertxGen` annotated types. getModuleName()
public String	getPackageName()
public List<TypeParamInfo.Class>	getParams()
public ClassTypeInfo	getRaw() Overrides io.vertx.codegen.type.TypeInfo.getRaw.
public String	getSimpleName(Case _case)
public boolean	isNullable() Overrides io.vertx.codegen.type.TypeInfo.isNullable.
public String	translateName(String the target language, for instance groovy id) Overrides io.vertx.codegen.type.TypeInfo.translateName. Translate the current type name based on the module group package name and the specified `lang` parameter.
public String	translateName(TypeNameTranslator translator) Overrides io.vertx.codegen.type.TypeInfo.translateName.
public String	translatePackageName(String id)
public String	translatePackageName(TypeNameTranslator translator)

Inherited from io.vertx.codegen.type.TypeInfo:: getErased getName getSimpleName hashCode isDataObjectHolder isParameterized isVariable isVoid toString

dataObject	back to summary
pack-priv final DataObjectInfo dataObject

kind	back to summary
pack-priv final ClassKind kind

module	back to summary
pack-priv final ModuleInfo module

name	back to summary
pack-priv final String name

nullable	back to summary
pack-priv final boolean nullable

packageName	back to summary
pack-priv final String packageName

params	back to summary
pack-priv final List<TypeParamInfo.Class> params

PRIMITIVES	back to summary
pack-priv static final HashMap<String, ClassTypeInfo> PRIMITIVES

simpleName	back to summary
pack-priv final String simpleName

ClassTypeInfo	back to summary
public ClassTypeInfo(ClassKind kind, String name, ModuleInfo module, boolean nullable, List<TypeParamInfo.Class> params, DataObjectInfo dataObject)

Method Detail

collectImports	back to summary
public void collectImports(Collection<ClassTypeInfo> imports) Overrides io.vertx.codegen.type.TypeInfo.collectImports. Doc from io.vertx.codegen.type.TypeInfo.collectImports. Collect the import fqcn needed by this type. Parameters imports:Collection<ClassTypeInfo> the imports Annotations @Override

collectImports

back to summary

public void collectImports(Collection<ClassTypeInfo> imports)

Overrides io.vertx.codegen.type.TypeInfo.collectImports.

Doc from io.vertx.codegen.type.TypeInfo.collectImports.

Collect the import fqcn needed by this type.

Parameters

imports:Collection<ClassTypeInfo>: the imports

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Implements abstract io.vertx.codegen.type.TypeInfo.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 obj: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

public boolean equals(Object obj)

Implements abstract io.vertx.codegen.type.TypeInfo.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

obj: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

format	back to summary
public String format(boolean qualified) Implements abstract io.vertx.codegen.type.TypeInfo.format. Doc from io.vertx.codegen.type.TypeInfo.format. Renders the type name. Parameters qualified:boolean true when class fqcn should be used, otherwise simple names will be used Returns:String the representation of the type Annotations @Override

format

back to summary

public String format(boolean qualified)

Implements abstract io.vertx.codegen.type.TypeInfo.format.

Doc from io.vertx.codegen.type.TypeInfo.format.

Renders the type name.

Parameters

qualified:boolean: true when class fqcn should be used, otherwise simple names will be used

Returns:String

the representation of the type

Annotations

@Override

getDataObject back to summary

getDataObject	back to summary
public DataObjectInfo getDataObject() Overrides io.vertx.codegen.type.TypeInfo.getDataObject. Returns:DataObjectInfo Doc from io.vertx.codegen.type.TypeInfo.getDataObject. the `DataObjectInfo` when this type can be adapted to a data object otherwise `null`

public DataObjectInfo getDataObject()

Overrides io.vertx.codegen.type.TypeInfo.getDataObject.

Returns:DataObjectInfo

Doc from io.vertx.codegen.type.TypeInfo.getDataObject.

the DataObjectInfo when this type can be adapted to a data object otherwise null

getKind	back to summary
public ClassKind getKind() Implements abstract io.vertx.codegen.type.TypeInfo.getKind. Returns:ClassKind Doc from io.vertx.codegen.type.TypeInfo.getKind. the class kind this type resolves to

getKind

back to summary

public ClassKind getKind()

Implements abstract io.vertx.codegen.type.TypeInfo.getKind.

Returns:ClassKind

Doc from io.vertx.codegen.type.TypeInfo.getKind.

the class kind this type resolves to

getModule	back to summary
public ModuleInfo getModule() Returns:ModuleInfo the optional module name only present for `io.vertx.codegen.annotations.VertxGen` annotated types.

getModuleName	back to summary
public String getModuleName() Returns:String the optional module name only present for `io.vertx.codegen.annotations.VertxGen` annotated types.

getPackageName	back to summary
public String getPackageName()

getParams	back to summary
public List<TypeParamInfo.Class> getParams()

getRaw	back to summary
public ClassTypeInfo getRaw() Overrides io.vertx.codegen.type.TypeInfo.getRaw. Returns:ClassTypeInfo Doc from io.vertx.codegen.type.TypeInfo.getRaw. the corresponding raw type or null Annotations @Override

getRaw

back to summary

public ClassTypeInfo getRaw()

Overrides io.vertx.codegen.type.TypeInfo.getRaw.

Returns:ClassTypeInfo

Doc from io.vertx.codegen.type.TypeInfo.getRaw.

the corresponding raw type or null

Annotations

@Override

getSimpleName	back to summary
public String getSimpleName(Case _case)

isNullable	back to summary
public boolean isNullable() Overrides io.vertx.codegen.type.TypeInfo.isNullable. Returns:boolean Doc from io.vertx.codegen.type.TypeInfo.isNullable. true if the type is nullable

isNullable

back to summary

public boolean isNullable()

Overrides io.vertx.codegen.type.TypeInfo.isNullable.

Returns:boolean

Doc from io.vertx.codegen.type.TypeInfo.isNullable.

true if the type is nullable

translateName back to summary

translateName	back to summary
public String translateName(String id) Overrides io.vertx.codegen.type.TypeInfo.translateName. Doc from io.vertx.codegen.type.TypeInfo.translateName. Translate the current type name based on the module group package name and the specified `lang` parameter. This has effect only for `ApiTypeInfo` or `ParameterizedTypeInfo` types. Parameters id:String the target language, for instance groovy Returns:String the translated name

public String translateName(String id)

Overrides io.vertx.codegen.type.TypeInfo.translateName.

Doc from io.vertx.codegen.type.TypeInfo.translateName.

Translate the current type name based on the module group package name and the specified lang parameter. This has effect only for ApiTypeInfo or ParameterizedTypeInfo types.

Parameters