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

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

Access	Constructor and Description
public	ClassModel(ProcessingEnvironment env, TypeMirrorFactory typeFactory, TypeElement modelElt)

Method Summary

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)
private MethodInfo	createMethod(ExecutableElement modelMethod, 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)
private void	determineApiTypes()
private TypeInfo	extractArg(String subType, DeclaredType declaredType)
private TypeInfo[]	extractArgs(String subType, DeclaredType declaredType)
private ConstantInfo	fieldMethod(Types typeUtils, VariableElement modelField, boolean allowAnyJavaType)
public List<TypeInfo>	getAbstractSuperTypes()
public List<AnnotationValueInfo>	Returns: all the annotations on this class getAnnotations() Overrides default io.vertx.codegen.Model.getAnnotations.
public List<MethodInfo>	getAnyJavaTypeMethods()
public TypeInfo	getConcreteSuperType()
public List<ConstantInfo>	getConstants()
public Text	Returns: the description of deprecated getDeprecatedDesc()
public Doc	getDoc()
public TypeElement	getElement() Implements io.vertx.codegen.Model.getElement.
public String	getFqn() Implements io.vertx.codegen.Model.getFqn.
public TypeInfo[]	getFunctionArgs()
public TypeInfo	getHandlerArg()
public String	getIfaceComment()
public String	getIfaceFQCN()
public String	getIfacePackageName()
public String	getIfaceSimpleName()
public Set<ClassTypeInfo>	Returns: all classes that are not in the same package getImportedTypes()
public List<MethodInfo>	getInstanceMethods()
public TypeInfo	getIterableArg()
public TypeInfo	getIteratorArg()
public String	getKind() Implements io.vertx.codegen.Model.getKind.
public Map<String, List<AnnotationValueInfo>>	Returns: a map of the method's annotations for this class, by method name. getMethodAnnotations()
public Map<String, List<MethodInfo>>	getMethodMap()
public List<MethodInfo>	getMethods()
public ModuleInfo	getModule() Implements io.vertx.codegen.Model.getModule.
public TypeInfo	getReadStreamArg()
public Set<ClassTypeInfo>	Returns: all the referenced data object types getReferencedDataObjectTypes()
public Set<EnumTypeInfo>	Returns: all the referenced enum types getReferencedEnumTypes()
public Set<ApiTypeInfo>	Returns: all the referenced api types getReferencedTypes()
public List<MethodInfo>	getStaticMethods()
public List<TypeInfo>	getSuperTypeArguments()
public List<TypeInfo>	getSuperTypes()
public ClassTypeInfo	getType()
public List<TypeParamInfo.Class>	getTypeParams()
public Map<String, Object>	getVars() Overrides default io.vertx.codegen.Model.getVars.
public TypeInfo	getWriteStreamArg()
public boolean	isConcrete()
public boolean	Returns: `true` if the class has a `@Deprecated` annotation isDeprecated()
public boolean	isFunction()
public boolean	isHandler()
public boolean	isIterable()
public boolean	isIterator()
private boolean	isObjectBound(TypeMirror bound)
public boolean	isReadStream()
public boolean	isWriteStream()
private void	logNonFutures()
public boolean	process() Implements io.vertx.codegen.Model.process.
private void	processTypeAnnotations()
private void	sortMethodMap(Map<String, List<MethodInfo>> map)
private void	traverseType(Element elem)

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

Field Detail

abstractSuperTypes	back to summary
protected List<TypeInfo> abstractSuperTypes

annotations	back to summary
protected List<AnnotationValueInfo> annotations

annotationValueInfoFactory	back to summary
protected final AnnotationValueInfoFactory annotationValueInfoFactory

anyJavaTypeMethods	back to summary
protected LinkedHashMap<ExecutableElement, MethodInfo> anyJavaTypeMethods

ASYNC_RESULT_TYPE	back to summary
private static final ClassTypeInfo ASYNC_RESULT_TYPE

collectedTypes	back to summary
protected Set<ClassTypeInfo> collectedTypes

concrete	back to summary
protected boolean concrete

concreteSuperType	back to summary
protected TypeInfo concreteSuperType

constants	back to summary
protected List<ConstantInfo> constants

deprecated	back to summary
protected boolean deprecated

deprecatedDesc	back to summary
protected Text deprecatedDesc

doc	back to summary
protected Doc doc

docFactory	back to summary
protected final Doc.Factory docFactory

elementUtils	back to summary
protected final Elements elementUtils

env	back to summary
protected final ProcessingEnvironment env

FUNCTION	back to summary
public static final String FUNCTION

functionArgs	back to summary
protected TypeInfo[] functionArgs

futureMethods	back to summary
protected Set<MethodInfo> futureMethods

HANDLER_TYPE	back to summary
private static final ClassTypeInfo HANDLER_TYPE

handlerArg	back to summary
protected TypeInfo handlerArg

ifaceComment	back to summary
protected String ifaceComment

ifaceFQCN	back to summary
protected String ifaceFQCN

ifacePackageName	back to summary
protected String ifacePackageName

ifaceSimpleName	back to summary
protected String ifaceSimpleName

importedTypes	back to summary
protected Set<ClassTypeInfo> importedTypes

ITERABLE	back to summary
public static final String ITERABLE

iterableArg	back to summary
protected TypeInfo iterableArg

ITERATOR	back to summary
public static final String ITERATOR

iteratorArg	back to summary
protected TypeInfo iteratorArg

JSON_ARRAY	back to summary
public static final String JSON_ARRAY

JSON_OBJECT	back to summary
public static final String JSON_OBJECT

logger	back to summary
private static final Logger logger

messager	back to summary
protected final Messager messager

methodAnnotationsMap	back to summary
protected Map<String, List<AnnotationValueInfo>> methodAnnotationsMap

methodMap	back to summary
protected Map<String, List<MethodInfo>> methodMap

methods	back to summary
protected LinkedHashMap<ExecutableElement, MethodInfo> methods

modelElt	back to summary
protected final TypeElement modelElt

processed	back to summary
protected boolean processed

readStreamArg	back to summary
protected TypeInfo readStreamArg

referencedDataObjectTypes	back to summary
protected Set<ClassTypeInfo> referencedDataObjectTypes

referencedEnumTypes	back to summary
protected Set<EnumTypeInfo> referencedEnumTypes

referencedTypes	back to summary
protected Set<ApiTypeInfo> referencedTypes

superTypeArguments	back to summary
private List<TypeInfo> superTypeArguments

superTypes	back to summary
protected List<TypeInfo> superTypes

type	back to summary
protected ClassTypeInfo type

typeFactory	back to summary
protected final TypeMirrorFactory typeFactory

typeUtils	back to summary
protected final Types typeUtils

VERTX	back to summary
public static final String VERTX

VERTX_ASYNC_RESULT	back to summary
public static final String VERTX_ASYNC_RESULT

VERTX_HANDLER	back to summary
public static final String VERTX_HANDLER

VERTX_READ_STREAM	back to summary
public static final String VERTX_READ_STREAM

VERTX_WRITE_STREAM	back to summary
public static final String VERTX_WRITE_STREAM

writeStreamArg	back to summary
protected TypeInfo writeStreamArg

Constructor Detail

ClassModel	back to summary
public ClassModel(ProcessingEnvironment env, TypeMirrorFactory typeFactory, TypeElement modelElt)

Method Detail

checkMethod	back to summary
protected void checkMethod(MethodInfo methodInfo)

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

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

createMethod	back to summary
private MethodInfo createMethod(ExecutableElement modelMethod, boolean allowAnyJavaType)

createMethodInfo

back to summary

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)

determineApiTypes	back to summary
private void determineApiTypes()

extractArg	back to summary
private TypeInfo extractArg(String subType, DeclaredType declaredType)

extractArgs	back to summary
private TypeInfo[] extractArgs(String subType, DeclaredType declaredType)

fieldMethod	back to summary
private ConstantInfo fieldMethod(Types typeUtils, VariableElement modelField, boolean allowAnyJavaType)

getAbstractSuperTypes	back to summary
public List<TypeInfo> getAbstractSuperTypes()

getAnnotations

back to summary

public List<AnnotationValueInfo> getAnnotations()

Overrides default io.vertx.codegen.Model.getAnnotations.

Returns:List<AnnotationValueInfo>: all the annotations on this class

getAnyJavaTypeMethods	back to summary
public List<MethodInfo> getAnyJavaTypeMethods()

getConcreteSuperType	back to summary
public TypeInfo getConcreteSuperType()

getConstants	back to summary
public List<ConstantInfo> getConstants()

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

getDoc	back to summary
public Doc getDoc()

getElement	back to summary
public TypeElement getElement() Implements io.vertx.codegen.Model.getElement.

getFqn

back to summary

public String getFqn()

Implements io.vertx.codegen.Model.getFqn.

Annotations

@Override

getFunctionArgs	back to summary
public TypeInfo[] getFunctionArgs()

getHandlerArg	back to summary
public TypeInfo getHandlerArg()

getIfaceComment	back to summary
public String getIfaceComment()

getIfaceFQCN	back to summary
public String getIfaceFQCN()

getIfacePackageName	back to summary
public String getIfacePackageName()

getIfaceSimpleName	back to summary
public String getIfaceSimpleName()

getImportedTypes	back to summary
public Set<ClassTypeInfo> getImportedTypes() Returns:Set<ClassTypeInfo> all classes that are not in the same package

getInstanceMethods	back to summary
public List<MethodInfo> getInstanceMethods()

getIterableArg	back to summary
public TypeInfo getIterableArg()

getIteratorArg	back to summary
public TypeInfo getIteratorArg()

getKind

back to summary

public String getKind()

Implements io.vertx.codegen.Model.getKind.

Annotations

@Override

getMethodAnnotations	back to summary
public Map<String, List<AnnotationValueInfo>> getMethodAnnotations() Returns:Map<String, List<AnnotationValueInfo>> a map of the method's annotations for this class, by method name.

getMethodMap	back to summary
public Map<String, List<MethodInfo>> getMethodMap()

getMethods	back to summary
public List<MethodInfo> getMethods()

getModule	back to summary
public ModuleInfo getModule() Implements io.vertx.codegen.Model.getModule.

getReadStreamArg	back to summary
public TypeInfo getReadStreamArg()

getReferencedDataObjectTypes	back to summary
public Set<ClassTypeInfo> getReferencedDataObjectTypes() Returns:Set<ClassTypeInfo> all the referenced data object types

getReferencedEnumTypes	back to summary
public Set<EnumTypeInfo> getReferencedEnumTypes() Returns:Set<EnumTypeInfo> all the referenced enum types

getReferencedTypes	back to summary
public Set<ApiTypeInfo> getReferencedTypes() Returns:Set<ApiTypeInfo> all the referenced api types

getStaticMethods	back to summary
public List<MethodInfo> getStaticMethods()

getSuperTypeArguments	back to summary
public List<TypeInfo> getSuperTypeArguments()

getSuperTypes	back to summary
public List<TypeInfo> getSuperTypes()

getType	back to summary
public ClassTypeInfo getType()

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

getVars

back to summary

public Map<String, Object> getVars()

Overrides default io.vertx.codegen.Model.getVars.

Annotations

@Override

getWriteStreamArg	back to summary
public TypeInfo getWriteStreamArg()

isConcrete	back to summary
public boolean isConcrete()

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

isFunction	back to summary
public boolean isFunction()

isHandler	back to summary
public boolean isHandler()

isIterable	back to summary
public boolean isIterable()

isIterator	back to summary
public boolean isIterator()

isObjectBound	back to summary
private boolean isObjectBound(TypeMirror bound)

isReadStream	back to summary
public boolean isReadStream()

isWriteStream	back to summary
public boolean isWriteStream()

logNonFutures	back to summary
private void logNonFutures()

process	back to summary
public boolean process() Implements io.vertx.codegen.Model.process.

processTypeAnnotations	back to summary
private void processTypeAnnotations()

sortMethodMap	back to summary
private void sortMethodMap(Map<String, List<MethodInfo>> map)

traverseType	back to summary
private void traverseType(Element elem)

public Class ClassModel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail