Package com.vaadin.flow.server.startup
Interface NavigationTargetFilter
-
- All Superinterfaces:
Serializable
public interface NavigationTargetFilter extends Serializable
A filter that can prevent specific navigation targets from being registered.Listener instances are by discovered and instantiated using
ServiceLoader
. This means that all implementations must have a zero-argument constructor and the fully qualified name of the implementation class must be listed on a separate line in a META-INF/services/com.vaadin.flow.server.startup.NavigationTargetFilter file present in the jar file containing the implementation class.- Since:
- 1.0
- Author:
- Vaadin Ltd
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
testErrorNavigationTarget(Class<?> errorNavigationTarget)
Tests whether the given error navigation target class should be included.boolean
testNavigationTarget(Class<? extends Component> navigationTarget)
Tests whether the given navigation target class should be included.
-
-
-
Method Detail
-
testNavigationTarget
boolean testNavigationTarget(Class<? extends Component> navigationTarget)
Tests whether the given navigation target class should be included.- Parameters:
navigationTarget
- the navigation target class to test- Returns:
true
to include the navigation target,false
to discard it
-
testErrorNavigationTarget
boolean testErrorNavigationTarget(Class<?> errorNavigationTarget)
Tests whether the given error navigation target class should be included.- Parameters:
errorNavigationTarget
- the error navigation target class to test- Returns:
true
to include the error navigation target,false
to discard it
-
-