com.vaadin.flow.plugin.common

Class ClassPathIntrospector

java.lang.Object

com.vaadin.flow.plugin.common.ClassPathIntrospector

Direct Known Subclasses:

AnnotationValuesExtractor, ThemedURLTranslator

public abstract class ClassPathIntrospector
extends Object

Abstract class which allows to find classes in the project classpath.

Since:

1.0

Author:

Vaadin Ltd

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClassPathIntrospector(ClassPathIntrospector otherIntrospector) Creates a new instance of class path introspector using the otherIntrpespector's reflection tools.
protected	ClassPathIntrospector(URL... projectClassesLocations) Creates a new instance of class path introspector using the projectClassesLocations.

Method Summary

Modifier and Type	Method and Description
protected Object	doInvokeAnnotationMethod(Annotation target, String methodName) Get the value of the method methodName from the target annotation.
protected Stream<Class<?>>	getAnnotatedClasses(Class<? extends Annotation> annotationInProjectContext) Gets the classes annotated with the given annotationInProjectContext annotation.
protected String	invokeAnnotationMethod(Annotation target, String methodName) Get the String value of the method methodName from the target annotation.
protected <T> Class<T>	loadClassInProjectClassLoader(String className) Returns the annotation class by its FQN.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPathIntrospector

protected ClassPathIntrospector(URL... projectClassesLocations)

Creates a new instance of class path introspector using the projectClassesLocations.

Parameters:

projectClassesLocations - urls to project class locations (directories, jars etc.)

ClassPathIntrospector

protected ClassPathIntrospector(ClassPathIntrospector otherIntrospector)

Creates a new instance of class path introspector using the otherIntrpespector's reflection tools.

Parameters:

otherIntrospector - the introspector whose reflection tools will be reused

Method Detail

getAnnotatedClasses

protected Stream<Class<?>> getAnnotatedClasses(Class<? extends Annotation> annotationInProjectContext)

Gets the classes annotated with the given annotationInProjectContext annotation.

Parameters:

annotationInProjectContext - annotation class

Returns:

all classes annotated with the given annotation

loadClassInProjectClassLoader

protected <T> Class<T> loadClassInProjectClassLoader(String className)

Returns the annotation class by its FQN.

Note that the resulting class is loaded by project classloader ( not the maven plugin classloader).

Type Parameters:

T - the class to be loaded

Parameters:

className - the FQN of the class to load

Returns:

the class with the given className loaded by the project class loader

invokeAnnotationMethod

protected String invokeAnnotationMethod(Annotation target,
                                        String methodName)

Get the String value of the method methodName from the target annotation.

Parameters:

target - the target annotation

methodName - the method name to execute

Returns:

the String representation of the execution result

doInvokeAnnotationMethod

protected Object doInvokeAnnotationMethod(Annotation target,
                                          String methodName)

Get the value of the method methodName from the target annotation.

Parameters:

target - the target annotation

methodName - the method name to execute

Returns:

the result of method methodName invocation on the target