cziegeler 02/02/06 00:41:11
Modified: src/java/org/apache/cocoon Constants.java
src/java/org/apache/cocoon/acting
RequestParameterExistsAction.java
src/java/org/apache/cocoon/caching
AggregatedCacheValidity.java
CompositeCacheValidity.java
ParametersCacheValidity.java
src/java/org/apache/cocoon/components/language/markup
CocoonMarkupLanguage.java
Log:
Add a little bit javadoc and fixed some typos
Revision Changes Path
1.6 +4 -4 xml-cocoon2/src/java/org/apache/cocoon/Constants.java
Index: Constants.java
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/java/org/apache/cocoon/Constants.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- Constants.java 5 Feb 2002 16:02:40 -0000 1.5
+++ Constants.java 6 Feb 2002 08:41:11 -0000 1.6
@@ -60,7 +60,7 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Stefano Mazzocchi</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Peter Royal</a>
- * @version CVS $Id: Constants.java,v 1.5 2002/02/05 16:02:40 cziegeler Exp $
+ * @version CVS $Id: Constants.java,v 1.6 2002/02/06 08:41:11 cziegeler Exp $
*/
public interface Constants {
@@ -237,7 +237,7 @@
* This constant is also defined in the
org.apache.cocoon.environment.ObjectModelHelper class.
*
* FIXME(GP): Shouldn't this definition here be removed?
- * @deprecated Use the @link
org.apache.cocoon.environment.ObjectModelHelper#getRequest() instead.
+ * @deprecated Use the {@link
org.apache.cocoon.environment.ObjectModelHelper#getRequest(Map)} instead.
*/
String REQUEST_OBJECT =
org.apache.cocoon.environment.ObjectModelHelper.REQUEST_OBJECT;
@@ -246,7 +246,7 @@
* This constant is also defined in the
org.apache.cocoon.environment.ObjectModelHelper class.
*
* FIXME(GP): Shouldn't this definition here be removed?
- * @deprecated Use the @link
org.apache.cocoon.environment.ObjectModelHelper#getResponse() instead.
+ * @deprecated Use the {@link
org.apache.cocoon.environment.ObjectModelHelper#getResponse(Map)} instead.
*/
String RESPONSE_OBJECT =
org.apache.cocoon.environment.ObjectModelHelper.RESPONSE_OBJECT;
@@ -255,7 +255,7 @@
* This constant is also defined in the
org.apache.cocoon.environment.ObjectModelHelper class.
*
* FIXME(GP): Shouldn't this definition here be removed?
- * @deprecated Use the @link
org.apache.cocoon.environment.ObjectModelHelper#getContext() instead.
+ * @deprecated Use the {@link
org.apache.cocoon.environment.ObjectModelHelper#getContext(Map)} instead.
*/
String CONTEXT_OBJECT =
org.apache.cocoon.environment.ObjectModelHelper.CONTEXT_OBJECT;
1.5 +2 -2
xml-cocoon2/src/java/org/apache/cocoon/acting/RequestParameterExistsAction.java
Index: RequestParameterExistsAction.java
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/java/org/apache/cocoon/acting/RequestParameterExistsAction.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- RequestParameterExistsAction.java 4 Feb 2002 12:08:39 -0000 1.4
+++ RequestParameterExistsAction.java 6 Feb 2002 08:41:11 -0000 1.5
@@ -78,7 +78,7 @@
* specific ones.
*
* <p>This action is very closely related to @link{RequestParamAction}
- * and @link{FormValidatorAction}. However this action is considerably
+ * and {@link FormValidatorAction}. However this action is considerably
* simpler in that it tests only for existence of a parameter and it
* doesn't need a descriptor. Besides it doesn't propagate all request
* parameters to the sitemap but only those that are marked as
@@ -89,7 +89,7 @@
* "name_1" must also exist and vice versa.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Christian Haul</a>
- * @version CVS $Id: RequestParameterExistsAction.java,v 1.4 2002/02/04 12:08:39
cziegeler Exp $
+ * @version CVS $Id: RequestParameterExistsAction.java,v 1.5 2002/02/06 08:41:11
cziegeler Exp $
*/
public class RequestParameterExistsAction extends AbstractConfigurableAction
{
1.5 +10 -2
xml-cocoon2/src/java/org/apache/cocoon/caching/AggregatedCacheValidity.java
Index: AggregatedCacheValidity.java
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/java/org/apache/cocoon/caching/AggregatedCacheValidity.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AggregatedCacheValidity.java 4 Feb 2002 12:13:05 -0000 1.4
+++ AggregatedCacheValidity.java 6 Feb 2002 08:41:11 -0000 1.5
@@ -60,20 +60,28 @@
import java.util.List;
/**
- * A validation object using a List.
+ * A validation object aggregating several validity objects. This is similar to the
+ * {@link CompositeCacheValidity} with the difference that the amount of
+ * aggregated objects is not limited.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Davanum Srinivas</a>
- * @version CVS $Id: AggregatedCacheValidity.java,v 1.4 2002/02/04 12:13:05
cziegeler Exp $
+ * @version CVS $Id: AggregatedCacheValidity.java,v 1.5 2002/02/06 08:41:11
cziegeler Exp $
*/
public final class AggregatedCacheValidity
implements CacheValidity {
private List a;
+ /**
+ * Constructor
+ */
public AggregatedCacheValidity() {
this.a = new ArrayList();
}
+ /**
+ * Add another validity object
+ */
public void add(CacheValidity validity) {
this.a.add(validity);
}
1.5 +7 -3
xml-cocoon2/src/java/org/apache/cocoon/caching/CompositeCacheValidity.java
Index: CompositeCacheValidity.java
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/java/org/apache/cocoon/caching/CompositeCacheValidity.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CompositeCacheValidity.java 4 Feb 2002 12:13:05 -0000 1.4
+++ CompositeCacheValidity.java 6 Feb 2002 08:41:11 -0000 1.5
@@ -58,10 +58,12 @@
/**
- * A validation object using a Hashmap.
+ * A validation object aggregating two validity objects. This is similar to the
+ * {@link AggregatedCacheValidity} with the difference that the amount of
+ * aggregated objects is limited.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Davanum Srinivas</a>
- * @version CVS $Id: CompositeCacheValidity.java,v 1.4 2002/02/04 12:13:05
cziegeler Exp $
+ * @version CVS $Id: CompositeCacheValidity.java,v 1.5 2002/02/06 08:41:11
cziegeler Exp $
*/
public final class CompositeCacheValidity
implements CacheValidity {
@@ -69,6 +71,9 @@
private CacheValidity v1;
private CacheValidity v2;
+ /**
+ * Constructor
+ */
public CompositeCacheValidity(CacheValidity v1, CacheValidity v2) {
this.v1 = v1;
this.v2 = v2;
@@ -93,5 +98,4 @@
public String toString() {
return new StringBuffer("CompositeCacheValidity:
").append(v1).append(":").append(v2).toString();
}
-
}
1.5 +9 -6
xml-cocoon2/src/java/org/apache/cocoon/caching/ParametersCacheValidity.java
Index: ParametersCacheValidity.java
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/java/org/apache/cocoon/caching/ParametersCacheValidity.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ParametersCacheValidity.java 4 Feb 2002 12:13:05 -0000 1.4
+++ ParametersCacheValidity.java 6 Feb 2002 08:41:11 -0000 1.5
@@ -55,20 +55,23 @@
package org.apache.cocoon.caching;
-import java.util.HashMap;
+import java.util.Map;
/**
- * A validation object using a Hashmap.
+ * A validation object using a set of key/value pairs contained in a
<code>Map</code>.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Davanum Srinivas</a>
- * @version CVS $Id: ParametersCacheValidity.java,v 1.4 2002/02/04 12:13:05
cziegeler Exp $
+ * @version CVS $Id: ParametersCacheValidity.java,v 1.5 2002/02/06 08:41:11
cziegeler Exp $
*/
public final class ParametersCacheValidity
implements CacheValidity {
- private HashMap map;
+ private Map map;
- public ParametersCacheValidity(HashMap map) {
+ /**
+ * Constructor
+ */
+ public ParametersCacheValidity(Map map) {
this.map = map;
}
@@ -79,7 +82,7 @@
return false;
}
- public HashMap getParameters() {
+ public Map getParameters() {
return this.map;
}
1.2 +4 -4
xml-cocoon2/src/java/org/apache/cocoon/components/language/markup/CocoonMarkupLanguage.java
Index: CocoonMarkupLanguage.java
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/java/org/apache/cocoon/components/language/markup/CocoonMarkupLanguage.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- CocoonMarkupLanguage.java 6 Feb 2002 04:40:28 -0000 1.1
+++ CocoonMarkupLanguage.java 6 Feb 2002 08:41:11 -0000 1.2
@@ -92,7 +92,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]";>Davanum Srinivas</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Ovidiu Predescu</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Vadim Gritsenko</a>
- * @version CVS $Id: CocoonMarkupLanguage.java,v 1.1 2002/02/06 04:40:28 vgritsenko
Exp $
+ * @version CVS $Id: CocoonMarkupLanguage.java,v 1.2 2002/02/06 08:41:11 cziegeler
Exp $
*/
public abstract class CocoonMarkupLanguage extends AbstractMarkupLanguage
{
@@ -128,7 +128,7 @@
* @param language The target programming language
* @return The preprocess filter
*
- * @see DefautlMarkupLanguage.PreProcessFilter
+ * @see PreProcessFilter
*/
protected XMLFilter getPreprocessFilter(String filename, ProgrammingLanguage
language) {
PreProcessFilter filter = new PreProcessFilter(filename, language);
@@ -409,10 +409,10 @@
CocoonMarkupLanguage.this.addLogicsheetToList(
language, href, this.resolver);
} catch (ProcessingException pe) {
- log.warn("DEfautlMarkupLanguage.startElement", pe);
+ log.warn("CocoonMarkupLanguage.startElement", pe);
throw new SAXException (pe);
} catch (IOException ioe) {
- log.warn("DEfautlMarkupLanguage.startElement", ioe);
+ log.warn("CocoonMarkupLanguage.startElement", ioe);
throw new SAXException (ioe);
}
} else {
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
