1717
1818import jakarta .servlet .annotation .HandlesTypes ;
1919
20+ import java .util .List ;
2021import java .util .Set ;
22+ import java .util .stream .Collectors ;
2123
2224import com .googlecode .gentyref .GenericTypeReflector ;
2325
3032import com .vaadin .flow .router .RouterLayout ;
3133import com .vaadin .flow .server .AmbiguousRouteConfigurationException ;
3234import com .vaadin .flow .server .InvalidRouteConfigurationException ;
35+ import com .vaadin .flow .server .InvalidRouteLayoutConfigurationException ;
3336import com .vaadin .flow .server .VaadinContext ;
3437import com .vaadin .flow .router .Layout ;
3538
@@ -63,6 +66,7 @@ public void initialize(Set<Class<?>> classSet, VaadinContext context)
6366 ApplicationRouteRegistry routeRegistry = ApplicationRouteRegistry
6467 .getInstance (context );
6568
69+ validateLayoutAnnotations (routesSet );
6670 routesSet .stream ()
6771 .filter (clazz -> clazz .isAnnotationPresent (Layout .class ))
6872 .filter (clazz -> RouterLayout .class .isAssignableFrom (clazz ))
@@ -88,6 +92,33 @@ public void initialize(Set<Class<?>> classSet, VaadinContext context)
8892 }
8993 }
9094
95+ /**
96+ * Validate {@link Layout} annotations that they are not added on classes
97+ * that do not extend {@link RouterLayout} as they can not work without the
98+ * implementation.
99+ *
100+ * @param routesSet
101+ * Routes to check
102+ * @throws InvalidRouteLayoutConfigurationException
103+ * Thrown if any {@link Layout} annotations are found on non
104+ * {@link RouterLayout} classes
105+ */
106+ public static void validateLayoutAnnotations (Set <Class <?>> routesSet )
107+ throws InvalidRouteLayoutConfigurationException {
108+ List <Class <?>> faultyLayouts = routesSet .stream ()
109+ .filter (clazz -> clazz .isAnnotationPresent (Layout .class ))
110+ .filter (clazz -> !RouterLayout .class .isAssignableFrom (clazz ))
111+ .collect (Collectors .toList ());
112+ if (!faultyLayouts .isEmpty ()) {
113+ String message = "Found @Layout on classes not extending RouterLayout.%nCheck the following classes: %s" ;
114+ String faultyLayoutsString = faultyLayouts .stream ()
115+ .map (clazz -> clazz .getName ())
116+ .collect (Collectors .joining ("," ));
117+ throw new InvalidRouteLayoutConfigurationException (
118+ String .format (message , faultyLayoutsString ));
119+ }
120+ }
121+
91122 private void configureStaticRoutesRegistry (VaadinContext context ,
92123 Set <Class <? extends Component >> routes ) {
93124 PreviouslyStoredRoutesRegistry registry = new PreviouslyStoredRoutesRegistry (
0 commit comments