Package 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:
ClassLoaderAwareServletContainerInitializer
,VaadinContextStartupInitializer
,VaadinServletContextStartupInitializer
,jakarta.servlet.ServletContainerInitializer
,Serializable
public class WebComponentExporterAwareValidator
extends AbstractAnnotationValidator
implements VaadinServletContextStartupInitializer
Checks that specific annotations are not configured wrong.
The validation is run during servlet container initialization.
For internal use only. May be renamed or removed in a future release.
- Since:
- 2.0
- Author:
- Vaadin Ltd.
- See Also:
-
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
-
Method Summary
Modifier and TypeMethodDescriptionGets the annotations that are subject to validate.protected String
Returns a hint for the discovered validation errors.handleNonRouterLayout
(Class<?> clazz) Handles theclazz
which is not a top level route and not a router layout.void
initialize
(Set<Class<?>> classSet, VaadinContext context) Applies this initializer to the given contextMethods inherited from class com.vaadin.flow.server.startup.AbstractAnnotationValidator
getClassAnnotations, getClassAnnotations, removeHandleTypesSelfReferences, validateClasses
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.vaadin.flow.server.startup.ClassLoaderAwareServletContainerInitializer
onStartup, requiresLookup
Methods inherited from interface com.vaadin.flow.server.startup.VaadinServletContextStartupInitializer
process
-
Constructor Details
-
WebComponentExporterAwareValidator
public WebComponentExporterAwareValidator()
-
-
Method Details
-
initialize
Description copied from interface:VaadinContextStartupInitializer
Applies this initializer to the given context- Specified by:
initialize
in interfaceVaadinContextStartupInitializer
- Parameters:
classSet
- the Set of application classes which this initializer needs to do its jobcontext
- theVaadinContext
to use with this initializer
-
handleNonRouterLayout
Description copied from class:AbstractAnnotationValidator
Handles theclazz
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 classAbstractAnnotationValidator
- Parameters:
clazz
- class to validate annotations- Returns:
- an optional error message or empty if there is no error
-
getErrorHint
Description copied from class:AbstractAnnotationValidator
Returns a hint for the discovered validation errors.- Overrides:
getErrorHint
in classAbstractAnnotationValidator
- Returns:
- the error hint
-
getAnnotations
Description copied from class:AbstractAnnotationValidator
Gets the annotations that are subject to validate.- Specified by:
getAnnotations
in classAbstractAnnotationValidator
- Returns:
- a list of target annotations
-