From 61c04df1a1c509cd7f24f92c077bc5faa020f509 Mon Sep 17 00:00:00 2001
From: Johannes Dahlström <johannesd@vaadin.com>
Date: Wed, 22 Aug 2012 15:05:02 +0300
Subject: Improved javadoc in (Abstract)DeploymentConfiguration (#9340)

---
 .../com/vaadin/terminal/DeploymentConfiguration.java |  8 ++++++++
 .../gwt/server/AbstractDeploymentConfiguration.java  | 20 ++++++++++++++++++++
 2 files changed, 28 insertions(+)

(limited to 'server')

diff --git a/server/src/com/vaadin/terminal/DeploymentConfiguration.java b/server/src/com/vaadin/terminal/DeploymentConfiguration.java
index 7d006812b9..8d5686ebbd 100644
--- a/server/src/com/vaadin/terminal/DeploymentConfiguration.java
+++ b/server/src/com/vaadin/terminal/DeploymentConfiguration.java
@@ -136,6 +136,8 @@ public interface DeploymentConfiguration extends Serializable {
     /**
      * Returns whether Vaadin is in production mode.
      * 
+     * @since 7.0.0
+     * 
      * @return true if in production mode, false otherwise.
      */
     public boolean isProductionMode();
@@ -143,6 +145,8 @@ public interface DeploymentConfiguration extends Serializable {
     /**
      * Returns whether cross-site request forgery protection is enabled.
      * 
+     * @since 7.0.0
+     * 
      * @return true if XSRF protection is enabled, false otherwise.
      */
     public boolean isXsrfProtectionEnabled();
@@ -150,6 +154,8 @@ public interface DeploymentConfiguration extends Serializable {
     /**
      * Returns the time resources can be cached in the browsers, in seconds.
      * 
+     * @since 7.0.0
+     * 
      * @return The resource cache time.
      */
     public int getResourceCacheTime();
@@ -158,6 +164,8 @@ public interface DeploymentConfiguration extends Serializable {
      * Returns the number of seconds between heartbeat requests of a root, or a
      * non-negative number if heartbeat is disabled.
      * 
+     * @since 7.0.0
+     * 
      * @return
      */
     public int getHeartbeatInterval();
diff --git a/server/src/com/vaadin/terminal/gwt/server/AbstractDeploymentConfiguration.java b/server/src/com/vaadin/terminal/gwt/server/AbstractDeploymentConfiguration.java
index d2cc4a2eea..1895560209 100644
--- a/server/src/com/vaadin/terminal/gwt/server/AbstractDeploymentConfiguration.java
+++ b/server/src/com/vaadin/terminal/gwt/server/AbstractDeploymentConfiguration.java
@@ -164,21 +164,41 @@ public abstract class AbstractDeploymentConfiguration implements
         return addonContext;
     }
 
+    /**
+     * {@inheritDoc}
+     * 
+     * The default is false.
+     */
     @Override
     public boolean isProductionMode() {
         return productionMode;
     }
 
+    /**
+     * {@inheritDoc}
+     * 
+     * The default is true.
+     */
     @Override
     public boolean isXsrfProtectionEnabled() {
         return xsrfProtectionEnabled;
     }
 
+    /**
+     * {@inheritDoc}
+     * 
+     * The default interval is 3600 seconds (1 hour).
+     */
     @Override
     public int getResourceCacheTime() {
         return resourceCacheTime;
     }
 
+    /**
+     * {@inheritDoc}
+     * 
+     * The default interval is 300 seconds (5 minutes).
+     */
     @Override
     public int getHeartbeatInterval() {
         return heartbeatInterval;
-- 
cgit v1.2.3