You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by cz...@apache.org on 2006/12/29 14:14:32 UTC
svn commit: r491000 - in
/cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration:
MutableSettings.java PropertyHelper.java PropertyProvider.java
Settings.java SettingsDefaults.java
Author: cziegeler
Date: Fri Dec 29 05:14:31 2006
New Revision: 491000
URL: http://svn.apache.org/viewvc?view=rev&rev=491000
Log:
Add some comments and set version to 1.0 in javadocs
Modified:
cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/MutableSettings.java
cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/PropertyHelper.java
cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/PropertyProvider.java
cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/Settings.java
cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/SettingsDefaults.java
Modified: cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/MutableSettings.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/MutableSettings.java?view=diff&rev=491000&r1=490999&r2=491000
==============================================================================
--- cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/MutableSettings.java (original)
+++ cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/MutableSettings.java Fri Dec 29 05:14:31 2006
@@ -23,10 +23,15 @@
import java.util.Properties;
/**
- * This object holds the global configuration of Cocoon.
+ * This is an implementation of the {@link Settings} object.
+ * The value can either be set using the various setter methods
+ * or through properties ({@link #configure(Properties)}.
+ *
+ * The object can be set to read-only using {@link #makeReadOnly()}. From that
+ * on the object is immutable and can't be changed anymore.
*
* @version $Id$
- * @since 2.2
+ * @since 1.0
*/
public class MutableSettings implements Settings {
@@ -107,7 +112,14 @@
this.runningMode = mode;
}
+ /**
+ * Create a new child settings object.
+ * @param parent The parent settings object.
+ */
public MutableSettings(Settings parent) {
+ if ( parent == null ) {
+ throw new IllegalArgumentException("Parent is not allowed to be null.");
+ }
this.parent = parent;
this.runningMode = parent.getRunningMode();
}
Modified: cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/PropertyHelper.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/PropertyHelper.java?view=diff&rev=491000&r1=490999&r2=491000
==============================================================================
--- cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/PropertyHelper.java (original)
+++ cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/PropertyHelper.java Fri Dec 29 05:14:31 2006
@@ -27,7 +27,7 @@
* property
*
* @version $Id$
- * @since 2.2
+ * @since 1.0
*/
public class PropertyHelper {
Modified: cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/PropertyProvider.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/PropertyProvider.java?view=diff&rev=491000&r1=490999&r2=491000
==============================================================================
--- cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/PropertyProvider.java (original)
+++ cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/PropertyProvider.java Fri Dec 29 05:14:31 2006
@@ -27,7 +27,7 @@
* context.
*
* @version $Id$
- * @since 2.2
+ * @since 1.0
*/
public interface PropertyProvider {
Modified: cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/Settings.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/Settings.java?view=diff&rev=491000&r1=490999&r2=491000
==============================================================================
--- cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/Settings.java (original)
+++ cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/Settings.java Fri Dec 29 05:14:31 2006
@@ -22,7 +22,7 @@
* This object holds the global configuration of Cocoon.
*
* @version $Id$
- * @since 2.2
+ * @since 1.0
*/
public interface Settings {
Modified: cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/SettingsDefaults.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/SettingsDefaults.java?view=diff&rev=491000&r1=490999&r2=491000
==============================================================================
--- cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/SettingsDefaults.java (original)
+++ cocoon/trunk/core/cocoon-configuration/cocoon-configuration-api/src/main/java/org/apache/cocoon/configuration/SettingsDefaults.java Fri Dec 29 05:14:31 2006
@@ -20,22 +20,30 @@
* This object defines the default values for the {@link Settings}.
*
* @version $Id$
- * @since 2.2
+ * @since 1.0
*/
public abstract class SettingsDefaults {
- /** The default running mode. */
+ /**
+ * The default running mode.
+ * @see Settings#getRunningMode()
+ */
public static final String DEFAULT_RUNNING_MODE = "prod";
- /** This is the list of predefined running modes. */
- // public static final String[] RUNNING_MODES = {"prod", "dev", "test"};
-
/**
* Default value for {@link Settings#isReloadingEnabled(String)} parameter (false).
*/
public static final boolean RELOADING_ENABLED_DEFAULT = false;
+ /**
+ * Default reload delay for configurations in milliseconds.
+ * @see Settings#getReloadDelay(String)
+ */
public static final long DEFAULT_CONFIGURATION_RELOAD_DELAY = 1000;
+ /**
+ * The default encoding for the web container.
+ * @see Settings#getContainerEncoding()
+ */
public static final String DEFAULT_CONTAINER_ENCODING = "ISO-8859-1";
}