You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by ha...@apache.org on 2002/02/28 14:35:58 UTC
cvs commit: jakarta-avalon/src/xdocs/framework changes.xml
hammant 02/02/28 05:35:58
Modified: src/java/org/apache/avalon/framework/logger
AbstractLogEnabled.java Loggable.java
src/java/org/apache/avalon/framework/parameters
Parameterizable.java Parameters.java
src/java/org/apache/avalon/framework/service
Serviceable.java
src/xdocs/developing framework.xml
src/xdocs/framework changes.xml
Log:
Changes to docs from MArk Woon
Revision Changes Path
1.4 +2 -0 jakarta-avalon/src/java/org/apache/avalon/framework/logger/AbstractLogEnabled.java
Index: AbstractLogEnabled.java
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/logger/AbstractLogEnabled.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AbstractLogEnabled.java 11 Dec 2001 09:00:46 -0000 1.3
+++ AbstractLogEnabled.java 28 Feb 2002 13:35:58 -0000 1.4
@@ -10,6 +10,8 @@
/**
* Utility class to allow construction of easy components that will perform logging.
*
+ * @deprecated Use {@link AbstractLogEnabled} instead.
+ *
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
*/
public abstract class AbstractLogEnabled
1.7 +1 -1 jakarta-avalon/src/java/org/apache/avalon/framework/logger/Loggable.java
Index: Loggable.java
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/logger/Loggable.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- Loggable.java 11 Dec 2001 09:00:46 -0000 1.6
+++ Loggable.java 28 Feb 2002 13:35:58 -0000 1.7
@@ -11,7 +11,7 @@
* Components that need to log can implement this interface to
* be provided Loggers.
*
- * @deprecated Use LogEnabled instead.
+ * @deprecated Use {@link LogEnabled} instead.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
* @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
1.5 +15 -5 jakarta-avalon/src/java/org/apache/avalon/framework/parameters/Parameterizable.java
Index: Parameterizable.java
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/parameters/Parameterizable.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Parameterizable.java 11 Dec 2001 09:00:47 -0000 1.4
+++ Parameterizable.java 28 Feb 2002 13:35:58 -0000 1.5
@@ -8,11 +8,21 @@
package org.apache.avalon.framework.parameters;
/**
- * Components should implement this interface if they wish to
- * be provided with parameters during startup. This interface
- * will be called after Composable.compose() and before
- * Initializable.initialize(). It is incompatible with the
- * Configurable interface.
+ * Components should implement this interface if they wish to
+ * be provided with parameters during startup.
+ * <p>
+ * The Parameterizable interface is a light-weight alternative to the
+ * {@link org.apache.avalon.framework.configuration.Configurable}
+ * interface. As such, the <code>Parameterizable</code> interface and
+ * the <code>Configurable</code> interface are <strong>not</strong>
+ * compatible.
+ * </p><p>
+ * This interface will be called after
+ * <code>Composable.compose()</code> and before
+ * <code>Initializable.initialize()</code>.
+ * </p>
+
+
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
*/
1.21 +22 -7 jakarta-avalon/src/java/org/apache/avalon/framework/parameters/Parameters.java
Index: Parameters.java
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/parameters/Parameters.java,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- Parameters.java 30 Dec 2001 06:26:39 -0000 1.20
+++ Parameters.java 28 Feb 2002 13:35:58 -0000 1.21
@@ -17,14 +17,29 @@
import org.apache.avalon.framework.configuration.ConfigurationException;
/**
- * The Parameters represents a set of key-value pairs.
- * Each value stored in Parameters has a key.
- * This class is similar to java.util.Properties with convenience methods
- * to access property values by type.
+ * The <code>Parameters</code> class represents a set of key-value
+ * pairs.
* <p>
- * <strong>Note, this class is not thread safe by default.</strong> If you
- * require thread safety please synchronize write access to this class to
- * prevent potential data corruption.
+ * The <code>Parameters</code> object provides a mechanism to obtain
+ * values based on a <code>String</code> name. There are convenience
+ * methods that allow you to use defaults if the value does not exist,
+ * as well as obtain the value in any of the same formats that are in
+ * the {@link Configuration} interface.
+ * </p><p>
+ * While there are similarities between the <code>Parameters</code>
+ * object and the java.util.Properties object, there are some
+ * important semantic differences. First, <code>Parameters</code> are
+ * <i>read-only</i>. Second, <code>Parameters</code> are easily
+ * derived from {@link Configuration} objects. Lastly, the
+ * <code>Parameters</code> object is derived from XML fragments that
+ * look like this:
+ * <pre><code>
+ * <parameter name="param-name" value="param-value" />
+ * </code></pre>
+ * </p><p>
+ * <strong>Note: this class is not thread safe by default.</strong> If you
+ * require thread safety please synchronize write access to this class to
+ * prevent potential data corruption.
* </p>
*
* @author <a href="mailto:fumagalli@exoffice.com">Pierpaolo Fumagalli</a>
1.3 +0 -1 jakarta-avalon/src/java/org/apache/avalon/framework/service/Serviceable.java
Index: Serviceable.java
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/service/Serviceable.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Serviceable.java 28 Feb 2002 03:54:59 -0000 1.2
+++ Serviceable.java 28 Feb 2002 13:35:58 -0000 1.3
@@ -21,7 +21,6 @@
* can be considered valid.
*
* @see org.apache.avalon.framework.service.ServiceManager
- * @see org.apache.avalon.framework.service.ServiceResolver
*
* @author <a href="mailto:fede@apache.org">Federico Barbieri</a>
* @author <a href="mailto:pier@apache.org">Pierpaolo Fumagalli</a>
1.13 +6 -11 jakarta-avalon/src/xdocs/developing/framework.xml
Index: framework.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/xdocs/developing/framework.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- framework.xml 18 Feb 2002 16:55:35 -0000 1.12
+++ framework.xml 28 Feb 2002 13:35:58 -0000 1.13
@@ -213,13 +213,10 @@
<listitem>
<para>
<function>configure</function>
- [<classname>Configurable</classname>]
- </para>
- </listitem>
- <listitem>
- <para>
+ [<classname>Configurable</classname>]
+ <emphasis>or</emphasis>
<function>parameterize</function>
- [<classname>Parameterizable</classname>]
+ [<classname>Parameterizable</classname>]
</para>
</listitem>
<listitem>
@@ -473,7 +470,7 @@
<title>Configuration</title>
<para>
This group of interfaces describes the concern area of configuration.
- If there are any problems like required
+ If there are any problems, such as required
<classname>Configuration</classname> elements that are missing, then
you may throw a <classname>ConfigurationException</classname>.
</para>
@@ -669,10 +666,8 @@
</para>
<para>
The contract is that this is called once during the lifecycle of
- the Component. Usually this interface is used in lieu of the
- <classname>Configurable</classname> interface, however if both are
- used, the <function>parameterize</function> method is called after
- the <function>configure</function> method.
+ the Component. This interface is not compatible with the
+ <classname>Configurable</classname> interface.
</para>
</section>
<section>
1.15 +1 -1 jakarta-avalon/src/xdocs/framework/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/xdocs/framework/changes.xml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- changes.xml 31 Jan 2002 17:12:53 -0000 1.14
+++ changes.xml 28 Feb 2002 13:35:58 -0000 1.15
@@ -27,7 +27,7 @@
<action dev="LM" type="update">
Update build to have a "compress.jars" property (defaults to
true by default).
- <action>
+ </action>
</release>
<release version="4.1.1" date="December 21, 2001">
<action dev="BL" type="fix">
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>