You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by an...@apache.org on 2004/08/16 18:06:15 UTC
cvs commit: cocoon-lenya/src/java/org/apache/lenya/ac/cache SourceCacheImpl.java BuildException.java URLKeyUtil.java SourceCache.java CachedObject.java CachingException.java InputStreamBuilder.java
andreas 2004/08/16 09:06:15
Modified: src/java/org/apache/lenya/ac/cache SourceCacheImpl.java
BuildException.java URLKeyUtil.java
SourceCache.java CachedObject.java
CachingException.java InputStreamBuilder.java
Log:
fixed javadocs
Revision Changes Path
1.5 +5 -2 cocoon-lenya/src/java/org/apache/lenya/ac/cache/SourceCacheImpl.java
Index: SourceCacheImpl.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/cache/SourceCacheImpl.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- SourceCacheImpl.java 26 Apr 2004 12:07:56 -0000 1.4
+++ SourceCacheImpl.java 16 Aug 2004 16:06:14 -0000 1.5
@@ -15,8 +15,6 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac.cache;
import java.io.IOException;
@@ -34,6 +32,10 @@
import org.apache.excalibur.source.SourceValidity;
import org.apache.lenya.util.CacheMap;
+/**
+ * Basic implementation of a source cache.
+ * @version $Id$
+ */
public class SourceCacheImpl
extends AbstractLogEnabled
implements SourceCache, Serviceable, Disposable {
@@ -181,6 +183,7 @@
* @throws MalformedURLException when an error occurs.
* @throws IOException when an error occurs.
* @throws SourceNotFoundException when an error occurs.
+ * @throws BuildException if an error occurs.
*/
protected Object buildObject(String sourceUri, InputStreamBuilder builder)
throws MalformedURLException, IOException, SourceNotFoundException, BuildException {
1.3 +4 -1 cocoon-lenya/src/java/org/apache/lenya/ac/cache/BuildException.java
Index: BuildException.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/cache/BuildException.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- BuildException.java 3 Mar 2004 12:56:32 -0000 1.2
+++ BuildException.java 16 Aug 2004 16:06:14 -0000 1.3
@@ -19,6 +19,9 @@
package org.apache.lenya.ac.cache;
+/**
+ * Exception for problems when cacheable objects are built.
+ */
public class BuildException extends Exception {
/**
1.3 +4 -2 cocoon-lenya/src/java/org/apache/lenya/ac/cache/URLKeyUtil.java
Index: URLKeyUtil.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/cache/URLKeyUtil.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- URLKeyUtil.java 3 Mar 2004 12:56:32 -0000 1.2
+++ URLKeyUtil.java 16 Aug 2004 16:06:14 -0000 1.3
@@ -15,8 +15,6 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac.cache;
import java.io.IOException;
@@ -25,6 +23,10 @@
import org.apache.excalibur.source.Source;
import org.apache.excalibur.source.SourceResolver;
+/**
+ * Utility class to generate String cache keys from webapp URLs.
+ * @version $Id$
+ */
public final class URLKeyUtil {
/**
1.3 +7 -2 cocoon-lenya/src/java/org/apache/lenya/ac/cache/SourceCache.java
Index: SourceCache.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/cache/SourceCache.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SourceCache.java 3 Mar 2004 12:56:32 -0000 1.2
+++ SourceCache.java 16 Aug 2004 16:06:14 -0000 1.3
@@ -15,14 +15,19 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac.cache;
import org.apache.avalon.framework.component.Component;
+/**
+ * Source cache component.
+ * @version $Id$
+ */
public interface SourceCache extends Component {
+ /**
+ * Avalon role of the SourceCache interface.
+ */
String ROLE = SourceCache.class.getName();
/**
1.3 +4 -2 cocoon-lenya/src/java/org/apache/lenya/ac/cache/CachedObject.java
Index: CachedObject.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/cache/CachedObject.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CachedObject.java 3 Mar 2004 12:56:32 -0000 1.2
+++ CachedObject.java 16 Aug 2004 16:06:14 -0000 1.3
@@ -15,12 +15,14 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac.cache;
import org.apache.excalibur.source.SourceValidity;
+/**
+ * Cached object.
+ * @version $Id$
+ */
public class CachedObject {
private SourceValidity validityObject;
1.3 +4 -2 cocoon-lenya/src/java/org/apache/lenya/ac/cache/CachingException.java
Index: CachingException.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/cache/CachingException.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CachingException.java 3 Mar 2004 12:56:32 -0000 1.2
+++ CachingException.java 16 Aug 2004 16:06:14 -0000 1.3
@@ -15,10 +15,12 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac.cache;
+/**
+ * Caching exception.
+ * @version $Id$
+ */
public class CachingException extends Exception {
/**
1.3 +4 -2 cocoon-lenya/src/java/org/apache/lenya/ac/cache/InputStreamBuilder.java
Index: InputStreamBuilder.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/ac/cache/InputStreamBuilder.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- InputStreamBuilder.java 3 Mar 2004 12:56:32 -0000 1.2
+++ InputStreamBuilder.java 16 Aug 2004 16:06:14 -0000 1.3
@@ -15,12 +15,14 @@
*
*/
-/* $Id$ */
-
package org.apache.lenya.ac.cache;
import java.io.InputStream;
+/**
+ * Interface for objects capable of building objects from input streams.
+ * @version $Id$
+ */
public interface InputStreamBuilder {
/**
---------------------------------------------------------------------
To unsubscribe, e-mail: lenya-cvs-unsubscribe@cocoon.apache.org
For additional commands, e-mail: lenya-cvs-help@cocoon.apache.org