ClassModel (vertx-codegen 4.3.8 API)

java.lang.Object
- io.vertx.codegen.ClassModel

All Implemented Interfaces:

Model
```
public class ClassModel
extends Object
implements Model
```
A processed source.

Author:

Tim Fox

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<TypeInfo>`	`abstractSuperTypes`
`protected List<AnnotationValueInfo>`	`annotations`
`protected AnnotationValueInfoFactory`	`annotationValueInfoFactory`
`protected LinkedHashMap<ExecutableElement,MethodInfo>`	`anyJavaTypeMethods`
`protected Set<ClassTypeInfo>`	`collectedTypes`
`protected boolean`	`concrete`
`protected TypeInfo`	`concreteSuperType`
`protected List<ConstantInfo>`	`constants`
`protected boolean`	`deprecated`
`protected Text`	`deprecatedDesc`
`protected Doc`	`doc`
`protected Doc.Factory`	`docFactory`
`protected Elements`	`elementUtils`
`protected ProcessingEnvironment`	`env`
`static String`	`FUNCTION`
`protected TypeInfo[]`	`functionArgs`
`protected Set<MethodInfo>`	`futureMethods`
`protected TypeInfo`	`handlerArg`
`protected String`	`ifaceComment`
`protected String`	`ifaceFQCN`
`protected String`	`ifacePackageName`
`protected String`	`ifaceSimpleName`
`protected Set<ClassTypeInfo>`	`importedTypes`
`static String`	`ITERABLE`
`protected TypeInfo`	`iterableArg`
`static String`	`ITERATOR`
`protected TypeInfo`	`iteratorArg`
`static String`	`JSON_ARRAY`
`static String`	`JSON_OBJECT`
`protected Messager`	`messager`
`protected Map<String,List<AnnotationValueInfo>>`	`methodAnnotationsMap`
`protected Map<String,List<MethodInfo>>`	`methodMap`
`protected LinkedHashMap<ExecutableElement,MethodInfo>`	`methods`
`protected TypeElement`	`modelElt`
`protected boolean`	`processed`
`protected TypeInfo`	`readStreamArg`
`protected Set<ClassTypeInfo>`	`referencedDataObjectTypes`
`protected Set<EnumTypeInfo>`	`referencedEnumTypes`
`protected Set<ApiTypeInfo>`	`referencedTypes`
`protected List<TypeInfo>`	`superTypes`
`protected ClassTypeInfo`	`type`
`protected TypeMirrorFactory`	`typeFactory`
`protected Types`	`typeUtils`
`static String`	`VERTX`
`static String`	`VERTX_ASYNC_RESULT`
`static String`	`VERTX_HANDLER`
`static String`	`VERTX_READ_STREAM`
`static String`	`VERTX_WRITE_STREAM`
`protected TypeInfo`	`writeStreamArg`

Constructor Summary

Constructors
Constructor and Description

ClassModel(ProcessingEnvironment env, TypeMirrorFactory typeFactory, TypeElement modelElt)

Constructors
Constructor and Description
`ClassModel(ProcessingEnvironment env, TypeMirrorFactory typeFactory, TypeElement modelElt)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkMethod(MethodInfo methodInfo)`
`protected void`	`checkParamType(ExecutableElement elem, TypeInfo typeInfo, int pos, int numParams, boolean allowAnyJavaType)`
`protected void`	`checkReturnType(ExecutableElement elem, TypeInfo type, boolean allowAnyJavaType)`
`protected MethodInfo`	`createMethodInfo(Set<ClassTypeInfo> ownerTypes, String methodName, String comment, Doc doc, TypeInfo returnType, Text returnDescription, boolean isFluent, boolean isCacheReturn, List<ParamInfo> mParams, ExecutableElement methodElt, boolean isStatic, boolean isDefault, ArrayList<TypeParamInfo.Method> typeParams, TypeElement declaringElt, boolean methodDeprecated, Text methodDeprecatedDesc, boolean useFutures, boolean methodOverride)`
`List<TypeInfo>`	`getAbstractSuperTypes()`
`List<AnnotationValueInfo>`	`getAnnotations()`
`List<MethodInfo>`	`getAnyJavaTypeMethods()`
`TypeInfo`	`getConcreteSuperType()`
`List<ConstantInfo>`	`getConstants()`
`Text`	`getDeprecatedDesc()`
`Doc`	`getDoc()`
`TypeElement`	`getElement()`
`String`	`getFqn()`
`TypeInfo[]`	`getFunctionArgs()`
`TypeInfo`	`getHandlerArg()`
`String`	`getIfaceComment()`
`String`	`getIfaceFQCN()`
`String`	`getIfacePackageName()`
`String`	`getIfaceSimpleName()`
`Set<ClassTypeInfo>`	`getImportedTypes()`
`List<MethodInfo>`	`getInstanceMethods()`
`TypeInfo`	`getIterableArg()`
`TypeInfo`	`getIteratorArg()`
`String`	`getKind()`
`Map<String,List<AnnotationValueInfo>>`	`getMethodAnnotations()`
`Map<String,List<MethodInfo>>`	`getMethodMap()`
`List<MethodInfo>`	`getMethods()`
`ModuleInfo`	`getModule()`
`TypeInfo`	`getReadStreamArg()`
`Set<ClassTypeInfo>`	`getReferencedDataObjectTypes()`
`Set<EnumTypeInfo>`	`getReferencedEnumTypes()`
`Set<ApiTypeInfo>`	`getReferencedTypes()`
`List<MethodInfo>`	`getStaticMethods()`
`List<TypeInfo>`	`getSuperTypeArguments()`
`List<TypeInfo>`	`getSuperTypes()`
`ClassTypeInfo`	`getType()`
`List<TypeParamInfo.Class>`	`getTypeParams()`
`Map<String,Object>`	`getVars()`
`TypeInfo`	`getWriteStreamArg()`
`boolean`	`isConcrete()`
`boolean`	`isDeprecated()`
`boolean`	`isFunction()`
`boolean`	`isHandler()`
`boolean`	`isIterable()`
`boolean`	`isIterator()`
`boolean`	`isReadStream()`
`boolean`	`isWriteStream()`
`boolean`	`process()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERTX_READ_STREAM

public static final String VERTX_READ_STREAM

See Also:: Constant Field Values

VERTX_WRITE_STREAM

public static final String VERTX_WRITE_STREAM

See Also:: Constant Field Values

VERTX_ASYNC_RESULT

public static final String VERTX_ASYNC_RESULT

See Also:: Constant Field Values

VERTX_HANDLER

public static final String VERTX_HANDLER

See Also:: Constant Field Values

JSON_OBJECT
```
public static final String JSON_OBJECT
```
See Also:

Constant Field Values

JSON_ARRAY
```
public static final String JSON_ARRAY
```
See Also:

Constant Field Values

VERTX
```
public static final String VERTX
```
See Also:

Constant Field Values

ITERABLE
```
public static final String ITERABLE
```
See Also:

Constant Field Values

ITERATOR
```
public static final String ITERATOR
```
See Also:

Constant Field Values

FUNCTION
```
public static final String FUNCTION
```
See Also:

Constant Field Values

env

protected final ProcessingEnvironment env

annotationValueInfoFactory

protected final AnnotationValueInfoFactory annotationValueInfoFactory

messager
```
protected final Messager messager
```

typeFactory

protected final TypeMirrorFactory typeFactory

docFactory
```
protected final Doc.Factory docFactory
```

modelElt
```
protected final TypeElement modelElt
```

elementUtils
```
protected final Elements elementUtils
```

typeUtils
```
protected final Types typeUtils
```

processed
```
protected boolean processed
```

methods

protected LinkedHashMap<ExecutableElement,MethodInfo> methods

anyJavaTypeMethods

protected LinkedHashMap<ExecutableElement,MethodInfo> anyJavaTypeMethods

futureMethods

protected Set<MethodInfo> futureMethods

constants
```
protected List<ConstantInfo> constants
```

collectedTypes

protected Set<ClassTypeInfo> collectedTypes

importedTypes

protected Set<ClassTypeInfo> importedTypes

referencedTypes

protected Set<ApiTypeInfo> referencedTypes

referencedDataObjectTypes

protected Set<ClassTypeInfo> referencedDataObjectTypes

referencedEnumTypes

protected Set<EnumTypeInfo> referencedEnumTypes

concrete
```
protected boolean concrete
```

type
```
protected ClassTypeInfo type
```

ifaceSimpleName
```
protected String ifaceSimpleName
```

ifaceFQCN
```
protected String ifaceFQCN
```

ifacePackageName
```
protected String ifacePackageName
```

ifaceComment
```
protected String ifaceComment
```

doc
```
protected Doc doc
```

superTypes
```
protected List<TypeInfo> superTypes
```

concreteSuperType
```
protected TypeInfo concreteSuperType
```

abstractSuperTypes

protected List<TypeInfo> abstractSuperTypes

handlerArg
```
protected TypeInfo handlerArg
```

readStreamArg
```
protected TypeInfo readStreamArg
```

writeStreamArg
```
protected TypeInfo writeStreamArg
```

iterableArg
```
protected TypeInfo iterableArg
```

iteratorArg
```
protected TypeInfo iteratorArg
```

functionArgs
```
protected TypeInfo[] functionArgs
```

methodMap

protected Map<String,List<MethodInfo>> methodMap

methodAnnotationsMap

protected Map<String,List<AnnotationValueInfo>> methodAnnotationsMap

annotations

protected List<AnnotationValueInfo> annotations

deprecated
```
protected boolean deprecated
```

deprecatedDesc
```
protected Text deprecatedDesc
```

Constructor Detail

ClassModel

public ClassModel(ProcessingEnvironment env,
                  TypeMirrorFactory typeFactory,
                  TypeElement modelElt)

Method Detail

getKind
```
public String getKind()
```
Specified by:

getKind in interface Model

getFqn
```
public String getFqn()
```
Specified by:

getFqn in interface Model

getElement
```
public TypeElement getElement()
```
Specified by:

getElement in interface Model

getMethods
```
public List<MethodInfo> getMethods()
```

getAnyJavaTypeMethods

public List<MethodInfo> getAnyJavaTypeMethods()

getStaticMethods

public List<MethodInfo> getStaticMethods()

getInstanceMethods

public List<MethodInfo> getInstanceMethods()

getConstants

public List<ConstantInfo> getConstants()

isConcrete
```
public boolean isConcrete()
```

getImportedTypes
```
public Set<ClassTypeInfo> getImportedTypes()
```
Returns:

all classes that are not in the same package

getReferencedTypes
```
public Set<ApiTypeInfo> getReferencedTypes()
```
Returns:

all the referenced api types

getReferencedDataObjectTypes
```
public Set<ClassTypeInfo> getReferencedDataObjectTypes()
```
Returns:

all the referenced data object types

getReferencedEnumTypes
```
public Set<EnumTypeInfo> getReferencedEnumTypes()
```
Returns:

all the referenced enum types

getIfaceSimpleName
```
public String getIfaceSimpleName()
```

getIfaceFQCN
```
public String getIfaceFQCN()
```

getIfacePackageName
```
public String getIfacePackageName()
```

getIfaceComment
```
public String getIfaceComment()
```

getDoc
```
public Doc getDoc()
```

getType
```
public ClassTypeInfo getType()
```

getModule
```
public ModuleInfo getModule()
```
Specified by:

getModule in interface Model

getSuperTypes
```
public List<TypeInfo> getSuperTypes()
```

getConcreteSuperType

public TypeInfo getConcreteSuperType()

getAbstractSuperTypes

public List<TypeInfo> getAbstractSuperTypes()

getMethodMap

public Map<String,List<MethodInfo>> getMethodMap()

getTypeParams

public List<TypeParamInfo.Class> getTypeParams()

getSuperTypeArguments

public List<TypeInfo> getSuperTypeArguments()

getAnnotations
```
public List<AnnotationValueInfo> getAnnotations()
```
Specified by:

getAnnotations in interface Model

Returns:

all the annotations on this class

getMethodAnnotations
```
public Map<String,List<AnnotationValueInfo>> getMethodAnnotations()
```
Returns:

a map of the method's annotations for this class, by method name.

process
```
public boolean process()
```
Specified by:

process in interface Model

checkParamType

protected void checkParamType(ExecutableElement elem,
                              TypeInfo typeInfo,
                              int pos,
                              int numParams,
                              boolean allowAnyJavaType)

checkReturnType

protected void checkReturnType(ExecutableElement elem,
                               TypeInfo type,
                               boolean allowAnyJavaType)

createMethodInfo

protected MethodInfo createMethodInfo(Set<ClassTypeInfo> ownerTypes,
                                      String methodName,
                                      String comment,
                                      Doc doc,
                                      TypeInfo returnType,
                                      Text returnDescription,
                                      boolean isFluent,
                                      boolean isCacheReturn,
                                      List<ParamInfo> mParams,
                                      ExecutableElement methodElt,
                                      boolean isStatic,
                                      boolean isDefault,
                                      ArrayList<TypeParamInfo.Method> typeParams,
                                      TypeElement declaringElt,
                                      boolean methodDeprecated,
                                      Text methodDeprecatedDesc,
                                      boolean useFutures,
                                      boolean methodOverride)

checkMethod

protected void checkMethod(MethodInfo methodInfo)

isDeprecated
```
public boolean isDeprecated()
```
Returns:

true if the class has a @Deprecated annotation

getDeprecatedDesc
```
public Text getDeprecatedDesc()
```
Returns:

the description of deprecated

getVars
```
public Map<String,Object> getVars()
```
Specified by:

getVars in interface Model

isHandler
```
public boolean isHandler()
```

getHandlerArg
```
public TypeInfo getHandlerArg()
```

isReadStream
```
public boolean isReadStream()
```

getReadStreamArg
```
public TypeInfo getReadStreamArg()
```

isWriteStream
```
public boolean isWriteStream()
```

getWriteStreamArg
```
public TypeInfo getWriteStreamArg()
```

isIterable
```
public boolean isIterable()
```

getIterableArg
```
public TypeInfo getIterableArg()
```

isIterator
```
public boolean isIterator()
```

getIteratorArg
```
public TypeInfo getIteratorArg()
```

isFunction
```
public boolean isFunction()
```

getFunctionArgs
```
public TypeInfo[] getFunctionArgs()
```

Class ClassModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERTX_READ_STREAM

VERTX_WRITE_STREAM

VERTX_ASYNC_RESULT

VERTX_HANDLER

JSON_OBJECT

JSON_ARRAY

VERTX

ITERABLE

ITERATOR

FUNCTION

env

annotationValueInfoFactory

messager

typeFactory

docFactory

modelElt

elementUtils

typeUtils

processed

methods

anyJavaTypeMethods

futureMethods

constants

collectedTypes

importedTypes

referencedTypes

referencedDataObjectTypes

referencedEnumTypes

concrete

type

ifaceSimpleName

ifaceFQCN

ifacePackageName

ifaceComment

doc

superTypes

concreteSuperType

abstractSuperTypes

handlerArg

readStreamArg

writeStreamArg

iterableArg

iteratorArg

functionArgs

methodMap

methodAnnotationsMap

annotations

deprecated

deprecatedDesc

Constructor Detail

ClassModel

Method Detail

getKind

getFqn

getElement

getMethods

getAnyJavaTypeMethods

getStaticMethods

getInstanceMethods

getConstants

isConcrete

getImportedTypes

getReferencedTypes

getReferencedDataObjectTypes

getReferencedEnumTypes

getIfaceSimpleName

getIfaceFQCN

getIfacePackageName

getIfaceComment

getDoc

getType

getModule

getSuperTypes

getConcreteSuperType