This is an automated email from the ASF dual-hosted git repository. ggregory 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 27ff49fd Javadoc typos 27ff49fd is described below commit 27ff49fd0fdd1db2d925c30faaebd2d3013859f2 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Fri May 19 08:49:55 2023 -0400 Javadoc typos --- .../auxiliary/lateral/LateralElementDescriptor.java | 2 +- .../lateral/socket/tcp/LateralTCPListener.java | 4 ++-- .../lateral/socket/tcp/LateralTCPService.java | 2 +- .../lateral/socket/tcp/TCPLateralCacheAttributes.java | 18 +++++++++--------- .../tcp/behavior/ITCPLateralCacheAttributes.java | 16 ++++++++-------- .../java/org/apache/commons/jcs3/engine/CacheInfo.java | 2 +- .../jcs3/utils/discovery/DiscoveredService.java | 2 +- .../commons/jcs/access/PartitionedCacheAccess.java | 4 ++-- .../commons/jcs/yajcache/file/CacheFileContent.java | 2 +- 9 files changed, 26 insertions(+), 26 deletions(-) diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralElementDescriptor.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralElementDescriptor.java index 5274466a..012c2403 100644 --- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralElementDescriptor.java +++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralElementDescriptor.java @@ -47,7 +47,7 @@ public class LateralElementDescriptor<K, V> public LateralCommand command = LateralCommand.UPDATE; /** - * The hashcode value for this element. + * The hash code value for this element. */ public int valHashCode = -1; diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPListener.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPListener.java index 8ac7de9e..18d5a03a 100644 --- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPListener.java +++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPListener.java @@ -728,7 +728,7 @@ public class LateralTCPListener<K, V> break; case REMOVE: - // if a hashcode was given and filtering is on + // if a hash code was given and filtering is on // check to see if they are the same // if so, then don't remove, otherwise issue a remove if (led.getValHashCode() != -1 && @@ -744,7 +744,7 @@ public class LateralTCPListener<K, V> led.getValHashCode(), led ); return null; } - log.debug( "Different hashcodes, in cache [{0}] sent [{1}]", + log.debug( "Different hash codes, in cache [{0}] sent [{1}]", test.getVal()::hashCode, led::getValHashCode ); } } diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPService.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPService.java index 75c6cd4c..855f3cb8 100644 --- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPService.java +++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPService.java @@ -145,7 +145,7 @@ public class LateralTCPService<K, V> new LateralElementDescriptor<>(item, LateralCommand.UPDATE, requesterId); sender.send( led ); } - // else issue a remove with the hashcode for remove check on + // else issue a remove with the hash code for remove check on // on the other end, this will be a server config option else { diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/TCPLateralCacheAttributes.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/TCPLateralCacheAttributes.java index 345cec73..adba78c0 100644 --- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/TCPLateralCacheAttributes.java +++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/TCPLateralCacheAttributes.java @@ -93,7 +93,7 @@ public class TCPLateralCacheAttributes /** call remove when there is a put */ private boolean issueRemoveOnPut = DEFAULT_ISSUE_REMOVE_FOR_PUT; - /** don't remove it the hashcode is the same */ + /** don't remove it the hash code is the same */ private boolean filterRemoveByHashCode = DEFAULT_FILTER_REMOVE_BY_HASH_CODE; /** Only block for socketTimeOut seconds before timing out on a read. */ @@ -355,10 +355,10 @@ public class TCPLateralCacheAttributes } /** - * Should the receiver try to match hashcodes. If true, the receiver will see if the client - * supplied a hashcode. If it did, then it will try to get the item locally. If the item exists, - * then it will compare the hashcode. if they are the same, it will not remove. This isn't - * perfect since different objects can have the same hashcode, but it is unlikely of objects of + * Should the receiver try to match hash codes. If true, the receiver will see if the client + * supplied a hash code. If it did, then it will try to get the item locally. If the item exists, + * then it will compare the hash code. if they are the same, it will not remove. This isn't + * perfect since different objects can have the same hash code, but it is unlikely of objects of * the same type. * <p> * @return boolean @@ -370,10 +370,10 @@ public class TCPLateralCacheAttributes } /** - * Should the receiver try to match hashcodes. If true, the receiver will see if the client - * supplied a hashcode. If it did, then it will try to get the item locally. If the item exists, - * then it will compare the hashcode. if they are the same, it will not remove. This isn't - * perfect since different objects can have the same hashcode, but it is unlikely of objects of + * Should the receiver try to match hash codes. If true, the receiver will see if the client + * supplied a hash code. If it did, then it will try to get the item locally. If the item exists, + * then it will compare the hash code. if they are the same, it will not remove. This isn't + * perfect since different objects can have the same hash code, but it is unlikely of objects of * the same type. * <p> * @param filter diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/behavior/ITCPLateralCacheAttributes.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/behavior/ITCPLateralCacheAttributes.java index e954fc4a..7273156c 100644 --- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/behavior/ITCPLateralCacheAttributes.java +++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/behavior/ITCPLateralCacheAttributes.java @@ -202,11 +202,11 @@ public interface ITCPLateralCacheAttributes boolean isIssueRemoveOnPut(); /** - * Should the receiver try to match hashcodes. If true, the receiver will - * see if the client supplied a hashcode. If it did, then it will try to get - * the item locally. If the item exists, then it will compare the hashcode. + * Should the receiver try to match hash codes. If true, the receiver will + * see if the client supplied a hash code. If it did, then it will try to get + * the item locally. If the item exists, then it will compare the hash code. * if they are the same, it will not remove. This isn't perfect since - * different objects can have the same hashcode, but it is unlikely of + * different objects can have the same hash code, but it is unlikely of * objects of the same type. * <p> * @return boolean @@ -214,11 +214,11 @@ public interface ITCPLateralCacheAttributes boolean isFilterRemoveByHashCode(); /** - * Should the receiver try to match hashcodes. If true, the receiver will - * see if the client supplied a hashcode. If it did, then it will try to get - * the item locally. If the item exists, then it will compare the hashcode. + * Should the receiver try to match hash codes. If true, the receiver will + * see if the client supplied a hash code. If it did, then it will try to get + * the item locally. If the item exists, then it will compare the hash code. * if they are the same, it will not remove. This isn't perfect since - * different objects can have the same hashcode, but it is unlikely of + * different objects can have the same hash code, but it is unlikely of * objects of the same type. * <p> * @param filter diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/CacheInfo.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/CacheInfo.java index 95633414..8683b88c 100644 --- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/CacheInfo.java +++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/CacheInfo.java @@ -41,6 +41,6 @@ public final class CacheInfo */ private static final VMID vmid = new VMID(); - /** By default this is the hashcode of the VMID */ + /** By default this is the hash code of the VMID */ public static final long listenerId = vmid.hashCode(); } diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/DiscoveredService.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/DiscoveredService.java index 4b5905f8..d97e6ddb 100644 --- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/DiscoveredService.java +++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/DiscoveredService.java @@ -131,7 +131,7 @@ public class DiscoveredService return lastHearFromTime; } - /** @return hashcode based on address/port */ + /** @return hash code based on address/port */ @Override public int hashCode() { diff --git a/commons-jcs-sandbox/partitioned/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java b/commons-jcs-sandbox/partitioned/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java index 6aaa8a33..0eb4d517 100644 --- a/commons-jcs-sandbox/partitioned/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java +++ b/commons-jcs-sandbox/partitioned/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java @@ -302,7 +302,7 @@ public class PartitionedCacheAccess<K, V> /** * This is tricky. Do we need to get from all the partitions? * <p> - * If this interface took an object, we could use the hashcode to determine the partition. Then + * If this interface took an object, we could use the hash code to determine the partition. Then * we could use the toString for the pattern. * <p> * @param pattern @@ -643,7 +643,7 @@ public class PartitionedCacheAccess<K, V> /** * This expects a numeric key. If the key cannot be converted into a number, we will return 0. - * TODO we could md5 it or get the hashcode. + * TODO we could md5 it or get the hash code. * <p> * We determine the partition by taking the mod of the number of partitions. * <p> diff --git a/commons-jcs-sandbox/yajcache/src/main/java/org/apache/commons/jcs/yajcache/file/CacheFileContent.java b/commons-jcs-sandbox/yajcache/src/main/java/org/apache/commons/jcs/yajcache/file/CacheFileContent.java index 9c95e5a8..a62b05f1 100644 --- a/commons-jcs-sandbox/yajcache/src/main/java/org/apache/commons/jcs/yajcache/file/CacheFileContent.java +++ b/commons-jcs-sandbox/yajcache/src/main/java/org/apache/commons/jcs/yajcache/file/CacheFileContent.java @@ -74,7 +74,7 @@ public class CacheFileContent { raf.writeByte(this.contentType); // Byte array length. raf.writeInt(this.contentLength); - // Byte array hashcode. + // Byte array hash code. raf.writeInt(this.contentHashCode); // Byte array. raf.write(this.content);