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 2021/05/24 16:23:57 UTC

[commons-jcs] branch master updated: JCS-225 - Fix Typo and Javadoc

This is an automated email from the ASF dual-hosted git repository.

tv pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-jcs.git


The following commit(s) were added to refs/heads/master by this push:
     new c56e5dd  JCS-225 - Fix Typo and Javadoc
     new 5e2237b  Merge pull request #67 from arturobernalg/feature/JCS-225
c56e5dd is described below

commit c56e5dd0a1d6ac35411b2c1c2f123b7b34130380
Author: Arturo Bernal <ar...@gmail.com>
AuthorDate: Sat May 22 07:23:58 2021 +0200

    JCS-225 - Fix Typo and Javadoc
---
 .../commons/jcs3/auxiliary/disk/indexed/IndexedDiskCache.java       | 6 +++---
 .../commons/jcs3/auxiliary/disk/jdbc/mysql/MySQLTableOptimizer.java | 2 +-
 .../apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWait.java   | 2 +-
 .../org/apache/commons/jcs3/auxiliary/remote/RemoteCacheNoWait.java | 2 +-
 .../jcs3/auxiliary/remote/behavior/IRemoteCacheListener.java        | 2 +-
 .../auxiliary/remote/http/client/RemoteHttpCacheAttributes.java     | 4 ++--
 .../jcs3/auxiliary/remote/http/client/RemoteHttpCacheClient.java    | 2 +-
 .../java/org/apache/commons/jcs3/engine/CacheEventQueueFactory.java | 2 +-
 .../apache/commons/jcs3/engine/behavior/IShutdownObservable.java    | 2 +-
 .../main/java/org/apache/commons/jcs3/utils/access/JCSWorker.java   | 6 +++---
 .../apache/commons/jcs3/utils/discovery/UDPDiscoveryManager.java    | 2 +-
 .../commons/jcs3/utils/discovery/UDPDiscoverySenderThread.java      | 2 +-
 12 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCache.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCache.java
index 5fbb888..c93928e 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCache.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCache.java
@@ -114,7 +114,7 @@ public class IndexedDiskCache<K, V> extends AbstractDiskCache<K, V>
     /** list where puts made during optimization are made */
     private final ConcurrentSkipListSet<IndexedDiskElementDescriptor> queuedPutList;
 
-    /** RECYLCE BIN -- array of empty spots */
+    /** RECYCLE BIN -- array of empty spots */
     private final ConcurrentSkipListSet<IndexedDiskElementDescriptor> recycle;
 
     /** User configurable parameters */
@@ -228,7 +228,7 @@ public class IndexedDiskCache<K, V> extends AbstractDiskCache<K, V>
 
         if (cattr.isClearDiskOnStartup())
         {
-            log.info("{0}: ClearDiskOnStartup is set to true.  Ingnoring any persisted data.",
+            log.info("{0}: ClearDiskOnStartup is set to true. Ignoring any persisted data.",
                     logCacheName);
             initializeEmptyStore();
         }
@@ -848,7 +848,7 @@ public class IndexedDiskCache<K, V> extends AbstractDiskCache<K, V>
     }
 
     /**
-     * Remove all the items from the disk cache by reseting everything.
+     * Remove all the items from the disk cache by resetting everything.
      */
     @Override
     public void processRemoveAll()
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/mysql/MySQLTableOptimizer.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/mysql/MySQLTableOptimizer.java
index 0f031a3..fa76409 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/mysql/MySQLTableOptimizer.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/mysql/MySQLTableOptimizer.java
@@ -55,7 +55,7 @@ public class MySQLTableOptimizer
     private final TableState tableState;
 
     /**
-     * This constructs an optimizer with the disk cacn properties.
+     * This constructs an optimizer with the disk can properties.
      * <p>
      * @param attributes
      * @param tableState We mark the table status as optimizing when this is happening.
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWait.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWait.java
index 840ce48..26e1e68 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWait.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWait.java
@@ -338,7 +338,7 @@ public class LateralCacheNoWait<K, V>
     }
 
     /**
-     * Returns the asyn cache status. An error status indicates either the lateral connection is not
+     * Returns the async cache status. An error status indicates either the lateral connection is not
      * available, or the asyn queue has been unexpectedly destroyed. No lateral invocation.
      * <p>
      * @return The status value
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCacheNoWait.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCacheNoWait.java
index 71c3f99..a9022fd 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCacheNoWait.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCacheNoWait.java
@@ -361,7 +361,7 @@ public class RemoteCacheNoWait<K, V>
     }
 
     /**
-     * Returns the asyn cache status. An error status indicates either the remote connection is not
+     * Returns the async cache status. An error status indicates either the remote connection is not
      * available, or the asyn queue has been unexpectedly destroyed. No remote invocation.
      * <p>
      * @return The status value
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/behavior/IRemoteCacheListener.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/behavior/IRemoteCacheListener.java
index fd5673b..bac58de 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/behavior/IRemoteCacheListener.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/behavior/IRemoteCacheListener.java
@@ -72,7 +72,7 @@ public interface IRemoteCacheListener<K, V>
         throws IOException;
 
     /**
-     * Deregisters itself.
+     * Deregistered itself.
      * <p>
      * @throws IOException
      */
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/http/client/RemoteHttpCacheAttributes.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/http/client/RemoteHttpCacheAttributes.java
index 2ee5357..670a51f 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/http/client/RemoteHttpCacheAttributes.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/http/client/RemoteHttpCacheAttributes.java
@@ -28,7 +28,7 @@ public class RemoteHttpCacheAttributes
     /** Don't change. */
     private static final long serialVersionUID = -5944327125140505212L;
 
-    /** http verison to use. */
+    /** http version to use. */
     private static final String DEFAULT_HTTP_VERSION = "1.1";
 
     /** The max connections allowed per host */
@@ -40,7 +40,7 @@ public class RemoteHttpCacheAttributes
     /** The socket connections timeout */
     private int connectionTimeoutMillis = 5000;
 
-    /** http verison to use. */
+    /** http version to use. */
     private String httpVersion = DEFAULT_HTTP_VERSION;
 
     /** The cache name will be included on the parameters */
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/http/client/RemoteHttpCacheClient.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/http/client/RemoteHttpCacheClient.java
index 33965a0..f486090 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/http/client/RemoteHttpCacheClient.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/http/client/RemoteHttpCacheClient.java
@@ -281,7 +281,7 @@ public class RemoteHttpCacheClient<K, V>
     }
 
     /**
-     * Remove all keys from the sepcified cache.
+     * Remove all keys from the specified cache.
      * <p>
      * @param cacheName
      * @param requesterId
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/CacheEventQueueFactory.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/CacheEventQueueFactory.java
index 31df019..37ef5e4 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/CacheEventQueueFactory.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/CacheEventQueueFactory.java
@@ -26,7 +26,7 @@ import org.apache.commons.jcs3.log.LogManager;
 
 /**
  * This class hands out event Queues. This allows us to change the implementation more easily. You
- * can confugure the cache to use a custom type.
+ * can configure the cache to use a custom type.
  * <p>
  * @author aaronsm
  */
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/behavior/IShutdownObservable.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/behavior/IShutdownObservable.java
index a2d28dc..6104406 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/behavior/IShutdownObservable.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/behavior/IShutdownObservable.java
@@ -46,7 +46,7 @@ public interface IShutdownObservable
     void registerShutdownObserver( IShutdownObserver observer );
 
     /**
-     * Deregisters the observer with the observable.
+     * Deregister the observer with the observable.
      *
      * @param observer
      */
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/access/JCSWorker.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/access/JCSWorker.java
index aad18b7..873c534 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/access/JCSWorker.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/access/JCSWorker.java
@@ -58,8 +58,8 @@ import org.apache.commons.jcs3.log.LogManager;
  *        JCSWorkerHelper helper = new AbstractJCSWorkerHelper(){
  *          public Object doWork(){
  *            // Do some (DB?) work here which results in a list
- *            // This only happens if the cache dosn't have a item in this region for aKey
- *            // Note this is especially useful with Hibernate, which will cache indiviual
+ *            // This only happens if the cache doesn't have a item in this region for aKey
+ *            // Note this is especially useful with Hibernate, which will cache individual
  *            // Objects, but not entire query result sets.
  *            List results = query.list();
  *            // Whatever we return here get's cached with aKey, and future calls to
@@ -246,7 +246,7 @@ public class JCSWorker<K, V>
             {
                 result = cache.get( aKey );
             }
-            // If the cache dosn't have it, do the work.
+            // If the cache doesn't have it, do the work.
             if ( result == null )
             {
                 result = aHelper.doWork();
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryManager.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryManager.java
index 312d6a8..3e17196 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryManager.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryManager.java
@@ -94,7 +94,7 @@ public class UDPDiscoveryManager
      * @param discoveryPort
      * @param serviceAddress
      * @param servicePort
-     * @param udpTTL
+     * @param updTTL
      * @param cacheMgr
      * @param serializer
      *
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySenderThread.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySenderThread.java
index 39d226c..e6d3ee9 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySenderThread.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySenderThread.java
@@ -139,7 +139,7 @@ public class UDPDiscoverySenderThread
         {
             sender.removeBroadcast( attributes.getServiceAddress(), attributes.getServicePort(), cacheNames );
 
-            log.debug( "Called sender to issue a remove broadcast in shudown." );
+            log.debug( "Called sender to issue a remove broadcast in shutdown." );
         }
         catch ( final IOException e )
         {