Update Navigator.getState() JavaDoc to be more accurate (#11876)

Fixes: https://github.com/vaadin/framework/issues/11875

diff --git a/server/src/main/java/com/vaadin/navigator/Navigator.java b/server/src/main/java/com/vaadin/navigator/Navigator.java
index fc22b19c3b842c98dfc7809ec72ec83055874f89..e7dc389d1e5425a6e58db9bac8ec300fe005ddd1 100644 (file)
--- a/server/src/main/java/com/vaadin/navigator/Navigator.java
+++ b/server/src/main/java/com/vaadin/navigator/Navigator.java
@@ -900,6 +900,11 @@ public class Navigator implements Serializable {
     /**
      * Returns the current navigation state reported by this Navigator's
      * {@link NavigationStateManager}.
+     * <p>
+     * When the navigation is triggered by the browser (for example by pressing
+     * the back or forward button in the browser), the navigation state may 
+     * already have been updated to reflect the new address, before the 
+     * {@link #navigateTo(String)} is notified.
      *
      * @return The navigation state.
      */