summaryrefslogtreecommitdiffstats
path: root/client
diff options
context:
space:
mode:
authorArtur Signell <artur@vaadin.com>2012-11-21 15:03:10 +0200
committerArtur Signell <artur@vaadin.com>2012-11-21 15:03:29 +0200
commitdb8acda48f638838c6c3f8f00e63e4b4595d603a (patch)
tree1ff2b397a1a9c314c9dacc1d978fe7e2b730eeeb /client
parent416b8a6d6b9eb580454f006b38a72ffe7f484638 (diff)
downloadvaadin-framework-db8acda48f638838c6c3f8f00e63e4b4595d603a.tar.gz
vaadin-framework-db8acda48f638838c6c3f8f00e63e4b4595d603a.zip
Updated ServerConnector javadoc (#10304)
Change-Id: Ia2a893b3b56d15a27bce839dcc92dc86e9b3996e
Diffstat (limited to 'client')
-rw-r--r--client/src/com/vaadin/client/ServerConnector.java5
1 files changed, 5 insertions, 0 deletions
diff --git a/client/src/com/vaadin/client/ServerConnector.java b/client/src/com/vaadin/client/ServerConnector.java
index 85eeab29ff..c5f42d3bd0 100644
--- a/client/src/com/vaadin/client/ServerConnector.java
+++ b/client/src/com/vaadin/client/ServerConnector.java
@@ -169,6 +169,11 @@ public interface ServerConnector extends Connector {
/**
* Gets the current shared state of the connector.
*
+ * Note that state is considered an internal part of the connector. You
+ * should not rely on the state object outside of the connector who owns it.
+ * If you depend on the state of other connectors you should use their
+ * public API instead of their state object directly.
+ *
* @since 7.0.
* @return state The shared state object. Can be any sub type of
* {@link SharedState}. Never null.