Author: painter
Date: Mon May 17 14:29:26 2021
New Revision: 1889962
URL: http://svn.apache.org/viewvc?rev=1889962&view=rev
Log:
Updates to Javadocs to allow mvn site to complete successfully
Modified:
turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/GlobalCacheService.java
turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/RefreshableCachedObject.java
turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.java
Modified:
turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/GlobalCacheService.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/GlobalCacheService.java?rev=1889962&r1=1889961&r2=1889962&view=diff
==============================================================================
---
turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/GlobalCacheService.java
(original)
+++
turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/GlobalCacheService.java
Mon May 17 14:29:26 2021
@@ -37,10 +37,11 @@ public interface GlobalCacheService
/**
* Gets a cached object given its id (a String).
*
+ * @param <T> type of object to return
* @param id
* The String id for the object.
* @return A CachedObject.
- * @exception ObjectExpiredException,
+ * @throws ObjectExpiredException
* if the object has expired in the cache.
*/
<T> CachedObject<T> getObject(String id) throws ObjectExpiredException;
@@ -48,6 +49,7 @@ public interface GlobalCacheService
/**
* Adds an object to the cache.
*
+ * @param <T> type of object to add
* @param id
* The String id for the object.
* @param o
@@ -84,6 +86,7 @@ public interface GlobalCacheService
* Returns the current size of the cache.
*
* @return int representing current cache size in number of bytes
+ * @throws IOException if unable to return cache size
*/
int getCacheSize() throws IOException;
Modified:
turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/RefreshableCachedObject.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/RefreshableCachedObject.java?rev=1889962&r1=1889961&r2=1889962&view=diff
==============================================================================
---
turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/RefreshableCachedObject.java
(original)
+++
turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/RefreshableCachedObject.java
Mon May 17 14:29:26 2021
@@ -113,6 +113,8 @@ public class RefreshableCachedObject<T e
/**
* Returns true if the object hasn't been touched in the previous TTL
* period.
+ *
+ * @return boolean status of object
*/
public synchronized boolean isUntouched()
{
Modified:
turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.java?rev=1889962&r1=1889961&r2=1889962&view=diff
==============================================================================
---
turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.java
(original)
+++
turbine/fulcrum/trunk/cache/src/java/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.java
Mon May 17 14:29:26 2021
@@ -117,7 +117,7 @@ public class DefaultGlobalCacheService e
* @param id
* The key of the stored object.
* @return The object from the cache.
- * @exception ObjectExpiredException,
+ * @throws ObjectExpiredException
* when either the object is not in the cache or it has
* expired.
*/
