io.vertx.codegen

Class Helper

java.lang.Object

io.vertx.codegen.Helper

public class Helper
extends Object

Author:

Tim Fox

Field Summary

Fields

Modifier and Type	Field and Description
static Function<Element,Stream<ExecutableElement>>	FILTER_METHOD
static Pattern	LINK_REFERENCE_PATTERN

Constructor Summary

Constructors

Constructor and Description
Helper()

Method Summary

Modifier and Type	Method and Description
static String	convertCamelCaseToUnderscores(String str)
static String	decapitaliseFirstLetter(String str)
static TypeElement	getElementTypeOf(Element elt) Return the element type of the specified element.
static String	getJavadocTag(String comment, String tagName)
static String	getNonGenericType(String type)
static String	getPackageName(String type)
static String	getSimpleName(String type)
static String	indentString(String str, String indent)
static String	normalizePropertyName(String propertyName) Normalize a property name: the first char will always be a lower case if the first char is an upper case, any following upper case char will be lower cased unless it is followed by a lower case char For instance: foo -> foo Foo -> foo URL -> url URLFactory -> urlFactory
static String	normalizeWhitespaces(String s) Trim and normalize the whitespaces in a string: any cluster of more than one whitespace char is replaced by a space char, then the string is trimmed.
static String	removeTags(String comment)
static Set<DeclaredType>	resolveAncestorTypes(TypeElement typeElt, boolean withSuper, boolean withInterfaces) Resolve the set of all the ancestors declared types of a given type element.
static AnnotationMirror	resolveMethodAnnotation(Class<? extends Annotation> annotationType, Elements elementUtils, Types typeUtils, TypeElement declaring, ExecutableElement method) Resolve a method annotation, this method scan the specified method, if the annotation is not found it will also scan the methods this method overrides and return the annotation when it is found.
static AnnotationMirror	resolveMethodAnnotation(DeclaredType annotationType, Elements elementUtils, Types typeUtils, TypeElement declaring, ExecutableElement method) Resolve a method annotation, this method scan the specified method, if the annotation is not found it will also scan the methods this method overrides and return the annotation when it is found.
static Element	resolveSignature(Elements elementUtils, Types typeUtils, TypeElement declaringElt, String signature) Resolves a documentation signature, null can be returned if no element can be resolved.
static TypeMirror	resolveTypeParameter(Types typeUtils, DeclaredType subType, TypeParameterElement typeParam) Return the type of a type parameter element of a given type element when that type parameter element is parameterized by a sub type, directly or indirectly.
static <T> Type	resolveTypeParameter(Type type, TypeVariable<Class<T>> typeParam) Return the type of a type parameter element of a given type element when that type parameter element is parameterized by a sub type, directly or indirectly.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FILTER_METHOD

public static final Function<Element,Stream<ExecutableElement>> FILTER_METHOD

LINK_REFERENCE_PATTERN

public static final Pattern LINK_REFERENCE_PATTERN

Constructor Detail

Helper

public Helper()

Method Detail

normalizePropertyName

public static String normalizePropertyName(String propertyName)

Normalize a property name:

• the first char will always be a lower case
• if the first char is an upper case, any following upper case char will be lower cased unless it is followed by a lower case char

For instance:

• foo -> foo
• Foo -> foo
• URL -> url
• URLFactory -> urlFactory

Parameters:

propertyName - the property name

Returns:

the normalized property name

decapitaliseFirstLetter

public static String decapitaliseFirstLetter(String str)

convertCamelCaseToUnderscores

public static String convertCamelCaseToUnderscores(String str)

getSimpleName

public static String getSimpleName(String type)

getPackageName

public static String getPackageName(String type)

getNonGenericType

public static String getNonGenericType(String type)

indentString

public static String indentString(String str,
                                  String indent)

getJavadocTag

public static String getJavadocTag(String comment,
                                   String tagName)

removeTags

public static String removeTags(String comment)

resolveMethodAnnotation

public static AnnotationMirror resolveMethodAnnotation(Class<? extends Annotation> annotationType,
                                                       Elements elementUtils,
                                                       Types typeUtils,
                                                       TypeElement declaring,
                                                       ExecutableElement method)

Resolve a method annotation, this method scan the specified method, if the annotation is not found it will also scan the methods this method overrides and return the annotation when it is found.

Parameters:

annotationType - the annotation type,

elementUtils - element utils

typeUtils - type utils

declaring - the element declaring the method

method - the method to start the resolution from

Returns:

the annotation if resolved otherwise null

resolveMethodAnnotation

public static AnnotationMirror resolveMethodAnnotation(DeclaredType annotationType,
                                                       Elements elementUtils,
                                                       Types typeUtils,
                                                       TypeElement declaring,
                                                       ExecutableElement method)

Resolve a method annotation, this method scan the specified method, if the annotation is not found it will also scan the methods this method overrides and return the annotation when it is found.

Parameters:

annotationType - the annotation type,

elementUtils - element utils

typeUtils - type utils

declaring - the element declaring the method

method - the method to start the resolution from

Returns:

the annotation if resolved otherwise null

resolveTypeParameter

public static TypeMirror resolveTypeParameter(Types typeUtils,
                                              DeclaredType subType,
                                              TypeParameterElement typeParam)

Return the type of a type parameter element of a given type element when that type parameter element is parameterized by a sub type, directly or indirectly. When the type parameter cannot be resolved, null is returned.

Parameters:

typeUtils - the type utils

subType - the sub type for which the type parameter is parameterized

typeParam - the type parameter to resolve

Returns:

the type parameterizing the type parameter

resolveTypeParameter

public static <T> Type resolveTypeParameter(Type type,
                                            TypeVariable<Class<T>> typeParam)

Return the type of a type parameter element of a given type element when that type parameter element is parameterized by a sub type, directly or indirectly. When the type parameter cannot be resolve, null is returned.

Parameters:

type - the sub type for which the type parameter is parameterized

typeParam - the type parameter to resolve

Returns:

the type parameterizing the type parameter

resolveSignature

public static Element resolveSignature(Elements elementUtils,
                                       Types typeUtils,
                                       TypeElement declaringElt,
                                       String signature)

Resolves a documentation signature, null can be returned if no element can be resolved.

Parameters:

elementUtils - the element utils

typeUtils - the type utils

declaringElt - the declaring element, may be null

signature - the signature to resolve

Returns:

the resolved element

getElementTypeOf

public static TypeElement getElementTypeOf(Element elt)

Return the element type of the specified element.

Parameters:

elt - the element

Returns:

the element type or null if none exists

normalizeWhitespaces

public static String normalizeWhitespaces(String s)

Trim and normalize the whitespaces in a string: any cluster of more than one whitespace char is replaced by a space char, then the string is trimmed.

Parameters:

s - the string to normalize

Returns:

the normalized string

resolveAncestorTypes

public static Set<DeclaredType> resolveAncestorTypes(TypeElement typeElt,
                                                     boolean withSuper,
                                                     boolean withInterfaces)

Resolve the set of all the ancestors declared types of a given type element.

Parameters:

typeElt - the type element to resolve

Returns:

the set of ancestors