aboutsummaryrefslogtreecommitdiffstats
path: root/server
diff options
context:
space:
mode:
authorLeif Åstrand <leif@vaadin.com>2012-09-10 13:58:30 +0300
committerLeif Åstrand <leif@vaadin.com>2012-09-10 13:58:30 +0300
commit2be77292ab17ba09ccb1dd6aec79b290905d9d1f (patch)
treeb49762f35b566fbe21c413f758684727c4e284c1 /server
parent38bcbdfa5c44564bed22cfac4ae17be4943bc6a1 (diff)
downloadvaadin-framework-2be77292ab17ba09ccb1dd6aec79b290905d9d1f.tar.gz
vaadin-framework-2be77292ab17ba09ccb1dd6aec79b290905d9d1f.zip
Add rudimentary javadocs (#9402)
Diffstat (limited to 'server')
-rw-r--r--server/src/com/vaadin/DefaultDeploymentConfiguration.java17
-rw-r--r--server/src/com/vaadin/server/AbstractVaadinService.java13
2 files changed, 30 insertions, 0 deletions
diff --git a/server/src/com/vaadin/DefaultDeploymentConfiguration.java b/server/src/com/vaadin/DefaultDeploymentConfiguration.java
index 6159137cc3..fed558c5b5 100644
--- a/server/src/com/vaadin/DefaultDeploymentConfiguration.java
+++ b/server/src/com/vaadin/DefaultDeploymentConfiguration.java
@@ -22,6 +22,13 @@ import java.util.logging.Logger;
import com.vaadin.server.Constants;
import com.vaadin.server.DeploymentConfiguration;
+/**
+ * The default implementation of {@link DeploymentConfiguration} based on a base
+ * class for resolving system properties and a set of init parameters.
+ *
+ * @author Vaadin Ltd
+ * @since 7.0.0
+ */
public class DefaultDeploymentConfiguration implements DeploymentConfiguration {
private final Properties initParameters;
private boolean productionMode;
@@ -31,6 +38,16 @@ public class DefaultDeploymentConfiguration implements DeploymentConfiguration {
private boolean idleRootCleanupEnabled;
private final Class<?> systemPropertyBaseClass;
+ /**
+ * Create a new deployment configuration instance.
+ *
+ * @param systemPropertyBaseClass
+ * the class that should be used as a basis when reading system
+ * properties
+ * @param initParameters
+ * the init parameters that should make up the foundation for
+ * this configuration
+ */
public DefaultDeploymentConfiguration(Class<?> systemPropertyBaseClass,
Properties initParameters) {
this.initParameters = initParameters;
diff --git a/server/src/com/vaadin/server/AbstractVaadinService.java b/server/src/com/vaadin/server/AbstractVaadinService.java
index 6e14c1984b..7150fdf0da 100644
--- a/server/src/com/vaadin/server/AbstractVaadinService.java
+++ b/server/src/com/vaadin/server/AbstractVaadinService.java
@@ -20,11 +20,24 @@ import java.lang.reflect.Constructor;
import java.util.Iterator;
import java.util.ServiceLoader;
+/**
+ * Abstract implementation of VaadinService that takes care of those parts that
+ * are common to both servlets and portlets.
+ *
+ * @author Vaadin Ltd
+ * @since 7.0.0
+ */
public abstract class AbstractVaadinService implements VaadinService {
private AddonContext addonContext;
private final DeploymentConfiguration deploymentConfiguration;
+ /**
+ * Creates a new vaadin service based on a deployment configuration
+ *
+ * @param deploymentConfiguration
+ * the deployment configuration for the service
+ */
public AbstractVaadinService(DeploymentConfiguration deploymentConfiguration) {
this.deploymentConfiguration = deploymentConfiguration;
}