com.vaadin.flow.server.startup

Class WebComponentExporterAwareValidator

java.lang.Object

com.vaadin.flow.server.startup.AbstractAnnotationValidator

com.vaadin.flow.server.startup.WebComponentExporterAwareValidator

All Implemented Interfaces:

Serializable, javax.servlet.ServletContainerInitializer

public class WebComponentExporterAwareValidator
extends AbstractAnnotationValidator
implements javax.servlet.ServletContainerInitializer

Checks that specific annotations are not configured wrong.

The validation is run during servlet container initialization.

Author:

Vaadin Ltd.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.vaadin.flow.server.startup.AbstractAnnotationValidator

ERROR_MESSAGE_BEGINNING, MIDDLE_ROUTER_LAYOUT, NON_PARENT, NON_PARENT_ALIAS, NON_ROUTER_LAYOUT

Constructor Summary

Constructors

Constructor and Description
WebComponentExporterAwareValidator()

Method Summary

Modifier and Type	Method and Description
List<Class<?>>	getAnnotations() Gets the annotations that are subject to validate.
protected String	getErrorHint() Returns a hint for the discovered validation errors.
protected Optional<String>	handleNonRouterLayout(Class<?> clazz) Handles the clazz which is not a top level route and not a router layout.
void	onStartup(Set<Class<?>> classSet, javax.servlet.ServletContext servletContext)

Methods inherited from class com.vaadin.flow.server.startup.AbstractAnnotationValidator

getClassAnnotations, validateClasses

Methods inherited from class java.lang.Object

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

Constructor Detail

WebComponentExporterAwareValidator

public WebComponentExporterAwareValidator()

Method Detail

onStartup

public void onStartup(Set<Class<?>> classSet,
                      javax.servlet.ServletContext servletContext)
               throws javax.servlet.ServletException

Specified by:

onStartup in interface javax.servlet.ServletContainerInitializer

Throws:

javax.servlet.ServletException

handleNonRouterLayout

protected Optional<String> handleNonRouterLayout(Class<?> clazz)

Description copied from class: AbstractAnnotationValidator

Handles the clazz which is not a top level route and not a router layout. Returns an optional message which describes the error having an annotation for the class.

Overrides:

handleNonRouterLayout in class AbstractAnnotationValidator

Parameters:

clazz - class to validate annotations

Returns:

an optional error message or empty if there is no error

getErrorHint

protected String getErrorHint()

Description copied from class: AbstractAnnotationValidator

Returns a hint for the discovered validation errors.

Overrides:

getErrorHint in class AbstractAnnotationValidator

Returns:

the error hint

getAnnotations

public List<Class<?>> getAnnotations()

Description copied from class: AbstractAnnotationValidator

Gets the annotations that are subject to validate.

Specified by:

getAnnotations in class AbstractAnnotationValidator

Returns:

a list of target annotations