From 2be77292ab17ba09ccb1dd6aec79b290905d9d1f Mon Sep 17 00:00:00 2001 From: Leif Åstrand Date: Mon, 10 Sep 2012 13:58:30 +0300 Subject: Add rudimentary javadocs (#9402) --- .../src/com/vaadin/DefaultDeploymentConfiguration.java | 17 +++++++++++++++++ server/src/com/vaadin/server/AbstractVaadinService.java | 13 +++++++++++++ 2 files changed, 30 insertions(+) (limited to 'server') 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; } -- cgit v1.2.3