vgritsenko 2003/03/11 08:33:38
Modified: src/java/org/apache/cocoon/transformation/helpers
DefaultIncludeCacheManager.java
IncludeCacheManager.java
IncludeCacheManagerSession.java
ModifiableSourceIncludeCacheStorageProxy.java
PreemptiveLoaderAction.java
StoreIncludeCacheStorageProxy.java
Log:
Fix javadocs
Revision Changes Path
1.2 +6 -6
cocoon-2.1/src/java/org/apache/cocoon/transformation/helpers/DefaultIncludeCacheManager.java
Index: DefaultIncludeCacheManager.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/helpers/DefaultIncludeCacheManager.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DefaultIncludeCacheManager.java 9 Mar 2003 00:09:41 -0000 1.1
+++ DefaultIncludeCacheManager.java 11 Mar 2003 16:33:37 -0000 1.2
@@ -78,7 +78,7 @@
import org.xml.sax.SAXException;
/**
- * Default implementation of a [EMAIL PROTECTED] CacheManager}.
+ * Default implementation of a [EMAIL PROTECTED] IncludeCacheManager}.
*
* This implementation requires a configuration, if preemptive
* loading is used:
@@ -113,7 +113,7 @@
private String preemptiveLoaderURI;
/**
- * @see
de.sundn.prod.sunshine.transformation.CacheManager#getSession(org.apache.avalon.framework.parameters.Parameters)
+ * @see
IncludeCacheManager#getSession(org.apache.avalon.framework.parameters.Parameters)
*/
public IncludeCacheManagerSession getSession(Parameters pars) {
String sourceURI = pars.getParameter("source", null);
@@ -157,7 +157,7 @@
}
/**
- * @see
de.sundn.prod.sunshine.transformation.CacheManager#load(java.lang.String, boolean,
de.sundn.prod.sunshine.transformation.CacheManagerSession)
+ * @see IncludeCacheManager#load(java.lang.String, IncludeCacheManagerSession)
*/
public String load(String uri,
IncludeCacheManagerSession session)
@@ -225,7 +225,7 @@
}
/**
- * @see
de.sundn.prod.sunshine.transformation.CacheManager#stream(java.lang.String,
de.sundn.prod.sunshine.transformation.CacheManagerSession, org.xml.sax.ContentHandler)
+ * @see IncludeCacheManager#stream(java.lang.String,
IncludeCacheManagerSession, XMLConsumer)
*/
public void stream(String uri,
IncludeCacheManagerSession session,
@@ -396,7 +396,7 @@
}
/**
- * @see
de.sundn.prod.sunshine.transformation.CacheManager#terminateSession(de.sundn.prod.sunshine.transformation.CacheManagerSession)
+ * @see IncludeCacheManager#terminateSession(IncludeCacheManagerSession)
*/
public void terminateSession(IncludeCacheManagerSession session) {
if (this.getLogger().isDebugEnabled()) {
1.2 +4 -4
cocoon-2.1/src/java/org/apache/cocoon/transformation/helpers/IncludeCacheManager.java
Index: IncludeCacheManager.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/helpers/IncludeCacheManager.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- IncludeCacheManager.java 9 Mar 2003 00:09:41 -0000 1.1
+++ IncludeCacheManager.java 11 Mar 2003 16:33:37 -0000 1.2
@@ -74,7 +74,7 @@
/**
* Create a session for this request.
* This should be invoked first and only one per request. It is required
- * to terminate the session with [EMAIL PROTECTED]
#terminateSession(CacheManagerSession)}
+ * to terminate the session with [EMAIL PROTECTED]
#terminateSession(IncludeCacheManagerSession)}
* @param pars The configuration
* @return CacheManagerSession The session that should be used with all other
commands.
*/
@@ -84,7 +84,7 @@
* This informs the manager that a URI should be "loaded".
* @param uri The URI to load (maybe relative)
* @param session The corresponding session created by [EMAIL PROTECTED]
#getSession(Parameters)}
- * @return String The absolute URI that must be used for [EMAIL PROTECTED]
#stream(String, CacheManagerSession, XMLConsumer)}
+ * @return String The absolute URI that must be used for [EMAIL PROTECTED]
#stream(String, IncludeCacheManagerSession, XMLConsumer)}
* @throws IOException
* @throws SourceException
*/
@@ -96,7 +96,7 @@
* Stream the content of the absolute URI.
* Depending on the configuration and state of the cache, the
* content is either taken from the cache, fetched etc.
- * @param uri The absolute URI returned by [EMAIL PROTECTED] #load(String,
CacheManagerSession)}
+ * @param uri The absolute URI returned by [EMAIL PROTECTED] #load(String,
IncludeCacheManagerSession)}
* @param session The current session
* @param handler The receiver of the SAX events
* @throws IOException
1.2 +4 -4
cocoon-2.1/src/java/org/apache/cocoon/transformation/helpers/IncludeCacheManagerSession.java
Index: IncludeCacheManagerSession.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/helpers/IncludeCacheManagerSession.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- IncludeCacheManagerSession.java 9 Mar 2003 00:09:41 -0000 1.1
+++ IncludeCacheManagerSession.java 11 Mar 2003 16:33:37 -0000 1.2
@@ -64,7 +64,7 @@
/**
* This object encapsulates a "caching session". A caching session has the
* duration of one single request.
- * This object is used by the [EMAIL PROTECTED] CacheManager} and holds all required
+ * This object is used by the [EMAIL PROTECTED] IncludeCacheManager} and holds all
required
* configuration for performing the caching of this request.
*
* The session can be configured during construction with the following parameters:
@@ -91,7 +91,7 @@
/** Should we process everything in parallel */
private boolean parallel;
- /** The used [EMAIL PROTECTED] CacheStorageProxy} */
+ /** The used [EMAIL PROTECTED] IncludeCacheStorageProxy} */
private IncludeCacheStorageProxy storage;
/** The list of all threads */
@@ -125,7 +125,7 @@
}
/**
- * @see de.sundn.prod.sunshine.transformation.CacheManagerSession#expires()
+ * @see IncludeCacheManagerSession#expires
*/
public long getExpires() {
return this.expires;
1.2 +7 -7
cocoon-2.1/src/java/org/apache/cocoon/transformation/helpers/ModifiableSourceIncludeCacheStorageProxy.java
Index: ModifiableSourceIncludeCacheStorageProxy.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/helpers/ModifiableSourceIncludeCacheStorageProxy.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ModifiableSourceIncludeCacheStorageProxy.java 9 Mar 2003 00:09:41 -0000
1.1
+++ ModifiableSourceIncludeCacheStorageProxy.java 11 Mar 2003 16:33:37 -0000
1.2
@@ -65,7 +65,7 @@
import org.apache.excalibur.source.SourceResolver;
/**
- * This is the interface between the [EMAIL PROTECTED] CacheManager} and a
+ * This is the interface between the [EMAIL PROTECTED] IncludeCacheManager} and a
* [EMAIL PROTECTED] Source} object that stores the cached content in a directory
* manner.
*
@@ -113,7 +113,7 @@
}
/**
- * @see
de.sundn.prod.sunshine.transformation.CacheStorageProxy#get(java.lang.String)
+ * @see IncludeCacheStorageProxy#get(java.lang.String)
*/
public Serializable get(String uri) {
if (logger.isDebugEnabled()) {
@@ -147,7 +147,7 @@
}
/**
- * @see
de.sundn.prod.sunshine.transformation.CacheStorageProxy#put(java.lang.String,
java.io.Serializable)
+ * @see IncludeCacheStorageProxy#put(java.lang.String, java.io.Serializable)
*/
public void put(String uri, Serializable object)
throws IOException {
@@ -182,7 +182,7 @@
}
/**
- * @see
de.sundn.prod.sunshine.transformation.CacheStorageProxy#remove(java.lang.String)
+ * @see IncludeCacheStorageProxy#remove(java.lang.String)
*/
public void remove(String uri) {
if (logger.isDebugEnabled()) {
@@ -195,8 +195,8 @@
if (logger.isDebugEnabled()) {
logger.debug("WSCProxy: Resolved to " + child.getURI());
}
- OutputStream os;
- if (child instanceof ModifiableSource) {
+
+ if (child instanceof ModifiableSource) {
((ModifiableSource)child).delete();
} else {
throw new IOException("Source " + uri + " is not writeable.");
1.2 +2 -3
cocoon-2.1/src/java/org/apache/cocoon/transformation/helpers/PreemptiveLoaderAction.java
Index: PreemptiveLoaderAction.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/helpers/PreemptiveLoaderAction.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PreemptiveLoaderAction.java 9 Mar 2003 00:09:41 -0000 1.1
+++ PreemptiveLoaderAction.java 11 Mar 2003 16:33:37 -0000 1.2
@@ -71,7 +71,7 @@
/**
* This action starts the preemptive loading
- * It runs forever and is stopped by the [EMAIL PROTECTED] DefaultCacheManager}.
+ * It runs forever and is stopped by the [EMAIL PROTECTED]
DefaultIncludeCacheManager}.
* @see org.apache.cocoon.acting.Action#act(Redirector, SourceResolver, Map,
String, Parameters)
*/
public Map act(Redirector redirector,
@@ -87,5 +87,4 @@
}
return null;
}
-
}
1.2 +5 -6
cocoon-2.1/src/java/org/apache/cocoon/transformation/helpers/StoreIncludeCacheStorageProxy.java
Index: StoreIncludeCacheStorageProxy.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/helpers/StoreIncludeCacheStorageProxy.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StoreIncludeCacheStorageProxy.java 9 Mar 2003 00:09:41 -0000 1.1
+++ StoreIncludeCacheStorageProxy.java 11 Mar 2003 16:33:37 -0000 1.2
@@ -57,7 +57,7 @@
import org.apache.excalibur.store.Store;
/**
- * This is the interface between the [EMAIL PROTECTED] CacheManager} and the usual
+ * This is the interface between the [EMAIL PROTECTED] IncludeCacheManager} and the
usual
* store.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
@@ -87,7 +87,7 @@
}
/**
- * @see
de.sundn.prod.sunshine.transformation.CacheStorageProxy#get(java.lang.String)
+ * @see IncludeCacheStorageProxy#get(java.lang.String)
*/
public Serializable get(String uri) {
if (logger.isDebugEnabled()) {
@@ -103,7 +103,7 @@
}
/**
- * @see
de.sundn.prod.sunshine.transformation.CacheStorageProxy#put(java.lang.String,
java.io.Serializable)
+ * @see IncludeCacheStorageProxy#put(java.lang.String, java.io.Serializable)
*/
public void put(String uri, Serializable object)
throws IOException {
@@ -114,7 +114,7 @@
}
/**
- * @see
de.sundn.prod.sunshine.transformation.CacheStorageProxy#remove(java.lang.String)
+ * @see IncludeCacheStorageProxy#remove(java.lang.String)
*/
public void remove(String uri) {
if (logger.isDebugEnabled()) {
@@ -122,5 +122,4 @@
}
this.store.remove(this.getKey(uri));
}
-
}
