You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by tv...@apache.org on 2015/12/11 11:28:56 UTC
svn commit: r1719331 - in
/commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs:
access/ auxiliary/disk/block/ auxiliary/disk/jdbc/
auxiliary/disk/jdbc/dsfactory/ auxiliary/lateral/socket/tcp/
auxiliary/remote/
Author: tv
Date: Fri Dec 11 10:28:55 2015
New Revision: 1719331
URL: http://svn.apache.org/viewvc?rev=1719331&view=rev
Log:
Fix javadoc
Modified:
commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/access/CacheAccess.java
commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCache.java
commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/JDBCDiskCache.java
commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/dsfactory/JndiDataSourceFactory.java
commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java
commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPService.java
commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/RemoteLocation.java
commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/RemoteUtils.java
Modified: commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/access/CacheAccess.java
URL: http://svn.apache.org/viewvc/commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/access/CacheAccess.java?rev=1719331&r1=1719330&r2=1719331&view=diff
==============================================================================
--- commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/access/CacheAccess.java (original)
+++ commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/access/CacheAccess.java Fri Dec 11 10:28:55 2015
@@ -19,6 +19,11 @@ package org.apache.commons.jcs.access;
* under the License.
*/
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+
import org.apache.commons.jcs.access.behavior.ICacheAccess;
import org.apache.commons.jcs.access.exception.CacheException;
import org.apache.commons.jcs.access.exception.InvalidArgumentException;
@@ -31,11 +36,6 @@ import org.apache.commons.jcs.engine.con
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
-import java.io.IOException;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Set;
-
/**
* This class provides an interface for all types of access to the cache.
* <p>
@@ -212,8 +212,7 @@ public class CacheAccess<K, V>
* <p>
* If the key or the value is null, and InvalidArgumentException is thrown.
* <p>
- * @see org.apache.commons.jcs.access.behavior.ICacheAccess#put(java.io.Serializable, java.io.Serializable,
- * org.apache.commons.jcs.engine.behavior.IElementAttributes)
+ * @see org.apache.commons.jcs.access.behavior.ICacheAccess#put(Object, Object, IElementAttributes)
*/
@Override
public void put( K key, V val, IElementAttributes attr )
Modified: commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCache.java
URL: http://svn.apache.org/viewvc/commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCache.java?rev=1719331&r1=1719330&r2=1719331&view=diff
==============================================================================
--- commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCache.java (original)
+++ commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCache.java Fri Dec 11 10:28:55 2015
@@ -306,10 +306,9 @@ public class BlockDiskCache<K, V>
* in the key store.</li> <li>If we found a key, ask the BlockDisk for the object at the
* blocks..</li> <li>Release the lock.</li>
* </ol>
- * (non-Javadoc)
* @param key
* @return ICacheElement
- * @see org.apache.commons.jcs.auxiliary.disk.AbstractDiskCache#doGet(java.io.Serializable)
+ * @see org.apache.commons.jcs.auxiliary.disk.AbstractDiskCache#get(Object)
*/
@Override
protected ICacheElement<K, V> processGet( K key )
@@ -366,7 +365,7 @@ public class BlockDiskCache<K, V>
* lock.</li>
* </ol>
* @param element
- * @see org.apache.commons.jcs.auxiliary.disk.AbstractDiskCache#doUpdate(org.apache.commons.jcs.engine.behavior.ICacheElement)
+ * @see org.apache.commons.jcs.auxiliary.disk.AbstractDiskCache#update(ICacheElement)
*/
@Override
protected void processUpdate( ICacheElement<K, V> element )
@@ -422,10 +421,9 @@ public class BlockDiskCache<K, V>
* Returns true if the removal was successful; or false if there is nothing to remove. Current
* implementation always result in a disk orphan.
* <p>
- * (non-Javadoc)
* @param key
* @return true if removed anything
- * @see org.apache.commons.jcs.auxiliary.disk.AbstractDiskCache#doRemove(java.io.Serializable)
+ * @see org.apache.commons.jcs.auxiliary.disk.AbstractDiskCache#remove(Object)
*/
@Override
protected boolean processRemove( K key )
@@ -523,7 +521,7 @@ public class BlockDiskCache<K, V>
/**
* Resets the keyfile, the disk file, and the memory key map.
* <p>
- * @see org.apache.commons.jcs.auxiliary.disk.AbstractDiskCache#doRemoveAll()
+ * @see org.apache.commons.jcs.auxiliary.disk.AbstractDiskCache#removeAll()
*/
@Override
protected void processRemoveAll()
@@ -684,7 +682,6 @@ public class BlockDiskCache<K, V>
/**
* Returns info about the disk cache.
* <p>
- * (non-Javadoc)
* @see org.apache.commons.jcs.auxiliary.AuxiliaryCache#getStatistics()
*/
@Override
Modified: commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/JDBCDiskCache.java
URL: http://svn.apache.org/viewvc/commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/JDBCDiskCache.java?rev=1719331&r1=1719330&r2=1719331&view=diff
==============================================================================
--- commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/JDBCDiskCache.java (original)
+++ commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/JDBCDiskCache.java Fri Dec 11 10:28:55 2015
@@ -451,7 +451,7 @@ public class JDBCDiskCache<K, V>
* <p>
* @param key
* @return ICacheElement
- * @see org.apache.commons.jcs.auxiliary.disk.AbstractDiskCache#doGet(java.io.Serializable)
+ * @see org.apache.commons.jcs.auxiliary.disk.AbstractDiskCache#get(Object)
*/
@Override
protected ICacheElement<K, V> processGet( K key )
Modified: commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/dsfactory/JndiDataSourceFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/dsfactory/JndiDataSourceFactory.java?rev=1719331&r1=1719330&r2=1719331&view=diff
==============================================================================
--- commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/dsfactory/JndiDataSourceFactory.java (original)
+++ commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/dsfactory/JndiDataSourceFactory.java Fri Dec 11 10:28:55 2015
@@ -79,7 +79,7 @@ public class JndiDataSourceFactory imple
}
/**
- * @see org.apache.torque.dsfactory.DataSourceFactory#getDataSource
+ * @see org.apache.commons.jcs.auxiliary.disk.jdbc.dsfactory.DataSourceFactory#getDataSource
*/
@Override
public DataSource getDataSource() throws SQLException
@@ -106,7 +106,7 @@ public class JndiDataSourceFactory imple
}
/**
- * @see org.apache.torque.dsfactory.DataSourceFactory#initialize
+ * @see org.apache.commons.jcs.auxiliary.disk.jdbc.DataSourceFactory#initialize
*/
@Override
public void initialize(JDBCDiskCacheAttributes config) throws SQLException
Modified: commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java?rev=1719331&r1=1719330&r2=1719331&view=diff
==============================================================================
--- commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java (original)
+++ commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java Fri Dec 11 10:28:55 2015
@@ -60,7 +60,7 @@ public class SharedPoolDataSourceFactory
}
/**
- * @see org.apache.torque.dsfactory.DataSourceFactory#getDataSource
+ * @see org.apache.commons.jcs.auxiliary.disk.jdbc.DataSourceFactory#getDataSource
*/
@Override
public DataSource getDataSource()
@@ -69,7 +69,7 @@ public class SharedPoolDataSourceFactory
}
/**
- * @see org.apache.torque.dsfactory.DataSourceFactory#initialize
+ * @see org.apache.commons.jcs.auxiliary.disk.jdbc.DataSourceFactory#initialize
*/
@Override
public void initialize(JDBCDiskCacheAttributes config) throws SQLException
Modified: commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPService.java
URL: http://svn.apache.org/viewvc/commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPService.java?rev=1719331&r1=1719330&r2=1719331&view=diff
==============================================================================
--- commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPService.java (original)
+++ commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPService.java Fri Dec 11 10:28:55 2015
@@ -19,6 +19,14 @@ package org.apache.commons.jcs.auxiliary
* under the License.
*/
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+
import org.apache.commons.jcs.auxiliary.lateral.LateralCommand;
import org.apache.commons.jcs.auxiliary.lateral.LateralElementDescriptor;
import org.apache.commons.jcs.auxiliary.lateral.socket.tcp.behavior.ITCPLateralCacheAttributes;
@@ -29,14 +37,6 @@ import org.apache.commons.jcs.engine.beh
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Set;
-
/**
* A lateral cache service implementation. Does not implement getGroupKey
* TODO: Remove generics
@@ -151,8 +151,7 @@ public class LateralTCPService<K, V>
/**
* Uses the default listener id and calls the next remove method.
* <p>
- * @see org.apache.commons.jcs.engine.behavior.ICacheService#remove(java.lang.String,
- * java.io.Serializable)
+ * @see org.apache.commons.jcs.engine.behavior.ICacheService#remove(String, Object)
*/
@Override
public void remove( String cacheName, K key )
@@ -164,8 +163,7 @@ public class LateralTCPService<K, V>
/**
* Wraps the key in a LateralElementDescriptor.
* <p>
- * @see org.apache.commons.jcs.engine.behavior.ICacheServiceNonLocal#remove(java.lang.String,
- * java.io.Serializable, long)
+ * @see org.apache.commons.jcs.engine.behavior.ICacheServiceNonLocal#remove(String, Object, long)
*/
@Override
public void remove( String cacheName, K key, long requesterId )
Modified: commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/RemoteLocation.java
URL: http://svn.apache.org/viewvc/commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/RemoteLocation.java?rev=1719331&r1=1719330&r2=1719331&view=diff
==============================================================================
--- commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/RemoteLocation.java (original)
+++ commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/RemoteLocation.java Fri Dec 11 10:28:55 2015
@@ -123,7 +123,7 @@ public final class RemoteLocation
* a RemoteLocation object
*
* @param server the input string
- * @returns the remote location object
+ * @return the remote location object
*/
public static RemoteLocation parseServerAndPort(final String server)
{
Modified: commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/RemoteUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/RemoteUtils.java?rev=1719331&r1=1719330&r2=1719331&view=diff
==============================================================================
--- commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/RemoteUtils.java (original)
+++ commons/proper/jcs/trunk/commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/RemoteUtils.java Fri Dec 11 10:28:55 2015
@@ -209,8 +209,8 @@ public class RemoteUtils
* Get the naming url used for RMI registration
*
* @param location the remote location
- * @param serviceName
- * @return
+ * @param serviceName the remote service name
+ * @return the URL for RMI lookup
*/
public static String getNamingURL(final RemoteLocation location, final String serviceName)
{
@@ -220,10 +220,10 @@ public class RemoteUtils
/**
* Get the naming url used for RMI registration
*
- * @param registryHost
- * @param registryPort
- * @param serviceName
- * @return
+ * @param registryHost the remote host
+ * @param registryPort the remote port
+ * @param serviceName the remote service name
+ * @return the URL for RMI lookup
*/
public static String getNamingURL(final String registryHost, final int registryPort, final String serviceName)
{