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 e0834d9e Javadoc
e0834d9e is described below
commit e0834d9ec8bd60f73ff1a9cf52867a4ecca210ea
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Mar 23 10:40:11 2025 -0400
Javadoc
---
.../socket/tcp/TCPLateralCacheAttributes.java | 38 +++++++--------
.../tcp/behavior/ITCPLateralCacheAttributes.java | 2 +-
.../jcs3/engine/CompositeCacheAttributes.java | 54 +++++++++++-----------
.../engine/behavior/ICompositeCacheAttributes.java | 6 +--
4 files changed, 50 insertions(+), 50 deletions(-)
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/TCPLateralCacheAttributes.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/TCPLateralCacheAttributes.java
index 6894ecde..b44d745d 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/TCPLateralCacheAttributes.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/TCPLateralCacheAttributes.java
@@ -122,7 +122,7 @@ public class TCPLateralCacheAttributes
/**
* Gets the tcpListenerHost attribute of the ILateralCacheAttributes object
- * <p>
+ *
* @return The tcpListenerHost value
*/
@Override
@@ -133,7 +133,7 @@ public class TCPLateralCacheAttributes
/**
* Gets the tcpListenerPort attribute of the ILateralCacheAttributes object
- * <p>
+ *
* @return The tcpListenerPort value
*/
@Override
@@ -144,7 +144,7 @@ public class TCPLateralCacheAttributes
/**
* Gets the tcpServer attribute of the ILateralCacheAttributes object
- * <p>
+ *
* @return The tcpServer value
*/
@Override
@@ -155,7 +155,7 @@ public class TCPLateralCacheAttributes
/**
* Gets the tcpServers attribute of the ILateralCacheAttributes object
- * <p>
+ *
* @return The tcpServers value
*/
@Override
@@ -166,7 +166,7 @@ public class TCPLateralCacheAttributes
/**
* The address to broadcast to if UDPDiscovery is enabled.
- * <p>
+ *
* @return the udpDiscoveryAddr.
*/
@Override
@@ -177,7 +177,7 @@ public class TCPLateralCacheAttributes
/**
* The port to use if UDPDiscovery is enabled.
- * <p>
+ *
* @return the udpDiscoveryPort.
*/
@Override
@@ -188,7 +188,7 @@ public class TCPLateralCacheAttributes
/**
* The time-to-live for the UDP multicast packets
- * <p>
+ *
* @return the udpTTL.
* @since 3.1
*/
@@ -200,7 +200,7 @@ public class TCPLateralCacheAttributes
/**
* Is the lateral allowed to try and get from other laterals.
- * <p>
+ *
* @return true if the lateral will try to get
*/
@Override
@@ -211,7 +211,7 @@ public class TCPLateralCacheAttributes
/**
* Is the lateral allowed to put objects to other laterals.
- * <p>
+ *
* @return true if puts are allowed
*/
@Override
@@ -226,7 +226,7 @@ public class TCPLateralCacheAttributes
* 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
*/
@Override
@@ -239,7 +239,7 @@ public class TCPLateralCacheAttributes
* Should the client send a remove command rather than a put when update
is called. This is a
* client option, not a receiver option. This allows you to prevent the
lateral from serializing
* objects.
- * <p>
+ *
* @return true if updates will result in a remove command being sent.
*/
@Override
@@ -249,8 +249,8 @@ public class TCPLateralCacheAttributes
}
/**
- * Whether or not TCP laterals can try to find each other by multicast
communication.
- * <p>
+ * Tests whether or not TCP laterals can try to find each other by
multicast communication.
+ *
* @return the udpDiscoveryEnabled.
*/
@Override
@@ -274,7 +274,7 @@ public class TCPLateralCacheAttributes
/**
* Is the lateral allowed to put objects to other laterals.
- * <p>
+ *
* @param allowPut
*/
@Override
@@ -289,7 +289,7 @@ public class TCPLateralCacheAttributes
* 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
*/
@Override
@@ -302,7 +302,7 @@ public class TCPLateralCacheAttributes
* Should the client send a remove command rather than a put when update
is called. This is a
* client option, not a receiver option. This allows you to prevent the
lateral from serializing
* objects.
- * <p>
+ *
* @param issueRemoveOnPut
*/
@Override
@@ -331,7 +331,7 @@ public class TCPLateralCacheAttributes
/**
* Sets the tcpListenerHost attribute of the ILateralCacheAttributes object
- * <p>
+ *
* @param val
* The new tcpListenerHost value
*/
@@ -343,7 +343,7 @@ public class TCPLateralCacheAttributes
/**
* Sets the tcpListenerPort attribute of the ILateralCacheAttributes object
- * <p>
+ *
* @param val The new tcpListenerPort value
*/
@Override
@@ -354,7 +354,7 @@ public class TCPLateralCacheAttributes
/**
* Sets the tcpServer attribute of the ILateralCacheAttributes object
- * <p>
+ *
* @param val The new tcpServer value
*/
@Override
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/behavior/ITCPLateralCacheAttributes.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/behavior/ITCPLateralCacheAttributes.java
index b86e8fa5..841accbf 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/behavior/ITCPLateralCacheAttributes.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/behavior/ITCPLateralCacheAttributes.java
@@ -125,7 +125,7 @@ public interface ITCPLateralCacheAttributes
boolean isIssueRemoveOnPut();
/**
- * Whether or not TCP laterals can try to find each other by multicast
+ * Tests whether or not TCP laterals can try to find each other by
multicast
* communication.
* <p>
* @return the udpDiscoveryEnabled.
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/CompositeCacheAttributes.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/CompositeCacheAttributes.java
index 120b0bda..5ec27550 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/CompositeCacheAttributes.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/CompositeCacheAttributes.java
@@ -127,7 +127,7 @@ public class CompositeCacheAttributes
/**
* Gets the cacheName attribute of the CompositeCacheAttributes object
- * <p>
+ *
* @return The cacheName value
*/
@Override
@@ -147,7 +147,7 @@ public class CompositeCacheAttributes
/**
* If UseMemoryShrinker is true the memory cache should auto-expire
elements to reclaim space.
- * <p>
+ *
* @return The MaxMemoryIdleTimeSeconds value
*/
@Override
@@ -158,7 +158,7 @@ public class CompositeCacheAttributes
/**
* Gets the maxObjects attribute of the CompositeCacheAttributes object
- * <p>
+ *
* @return The maxObjects value
*/
@Override
@@ -170,7 +170,7 @@ public class CompositeCacheAttributes
/**
* If UseMemoryShrinker is true the memory cache should auto-expire
elements to reclaim space.
* This gets the maximum number of items to spool per run.
- * <p>
+ *
* @return The maxSpoolPerRun value
*/
@Override
@@ -181,7 +181,7 @@ public class CompositeCacheAttributes
/**
* Gets the memoryCacheName attribute of the CompositeCacheAttributes
object
- * <p>
+ *
* @return The memoryCacheName value
*/
@Override
@@ -193,7 +193,7 @@ public class CompositeCacheAttributes
/**
* If UseMemoryShrinker is true the memory cache should auto-expire
elements to reclaim space.
* This gets the shrinker interval.
- * <p>
+ *
* @return The ShrinkerIntervalSeconds value
*/
@Override
@@ -204,7 +204,7 @@ public class CompositeCacheAttributes
/**
* Number to send to disk at the time when memory is full.
- * <p>
+ *
* @return int
*/
@Override
@@ -215,7 +215,7 @@ public class CompositeCacheAttributes
/**
* Gets the useDisk attribute of the CompositeCacheAttributes object
- * <p>
+ *
* @return The useDisk value
*/
@Override
@@ -226,7 +226,7 @@ public class CompositeCacheAttributes
/**
* Gets the useLateral attribute of the CompositeCacheAttributes object
- * <p>
+ *
* @return The useLateral value
*/
@Override
@@ -236,8 +236,8 @@ public class CompositeCacheAttributes
}
/**
- * Whether the memory cache should perform background memory shrinkage.
- * <p>
+ * Tests whether the memory cache should perform background memory
shrinkage.
+ *
* @return The UseMemoryShrinker value
*/
@Override
@@ -248,7 +248,7 @@ public class CompositeCacheAttributes
/**
* Gets the useRemote attribute of the CompositeCacheAttributes object
- * <p>
+ *
* @return The useRemote value
*/
@Override
@@ -259,7 +259,7 @@ public class CompositeCacheAttributes
/**
* Sets the cacheName attribute of the CompositeCacheAttributes object
- * <p>
+ *
* @param s The new cacheName value
*/
@Override
@@ -270,7 +270,7 @@ public class CompositeCacheAttributes
/**
* By default this is SWAP_ONLY.
- * <p>
+ *
* @param diskUsagePattern The diskUsagePattern to set.
*/
@Override
@@ -283,7 +283,7 @@ public class CompositeCacheAttributes
* Translates the name to the disk usage pattern short value.
* <p>
* The allowed values are SWAP and UPDATE.
- * <p>
+ *
* @param diskUsagePatternName The diskUsagePattern to set.
*/
@Override
@@ -305,7 +305,7 @@ public class CompositeCacheAttributes
/**
* If UseMemoryShrinker is true the memory cache should auto-expire
elements to reclaim space.
- * <p>
+ *
* @param seconds The new MaxMemoryIdleTimeSeconds value
*/
@Override
@@ -316,7 +316,7 @@ public class CompositeCacheAttributes
/**
* Sets the maxObjects attribute of the CompositeCacheAttributes object
- * <p>
+ *
* @param maxObjs The new maxObjects value
*/
@Override
@@ -330,7 +330,7 @@ public class CompositeCacheAttributes
* This sets the maximum number of items to spool per run.
* <p>
* If the value is -1, then there is no limit to the number of items to be
spooled.
- * <p>
+ *
* @param maxSpoolPerRun The new maxSpoolPerRun value
*/
@Override
@@ -341,7 +341,7 @@ public class CompositeCacheAttributes
/**
* Sets the memoryCacheName attribute of the CompositeCacheAttributes
object
- * <p>
+ *
* @param s The new memoryCacheName value
*/
@Override
@@ -353,7 +353,7 @@ public class CompositeCacheAttributes
/**
* If UseMemoryShrinker is true the memory cache should auto-expire
elements to reclaim space.
* This sets the shrinker interval.
- * <p>
+ *
* @param seconds The new ShrinkerIntervalSeconds value
*/
@Override
@@ -364,7 +364,7 @@ public class CompositeCacheAttributes
/**
* Number to send to disk at a time.
- * <p>
+ *
* @param spoolChunkSize
*/
@Override
@@ -375,7 +375,7 @@ public class CompositeCacheAttributes
/**
* Sets the useDisk attribute of the CompositeCacheAttributes object
- * <p>
+ *
* @param useDisk The new useDisk value
*/
@Override
@@ -386,7 +386,7 @@ public class CompositeCacheAttributes
/**
* Sets the useLateral attribute of the CompositeCacheAttributes object
- * <p>
+ *
* @param b The new useLateral value
*/
@Override
@@ -396,8 +396,8 @@ public class CompositeCacheAttributes
}
/**
- * Whether the memory cache should perform background memory shrinkage.
- * <p>
+ * Sets whether the memory cache should perform background memory
shrinkage.
+ *
* @param useShrinker The new UseMemoryShrinker value
*/
@Override
@@ -408,7 +408,7 @@ public class CompositeCacheAttributes
/**
* Sets the useRemote attribute of the CompositeCacheAttributes object
- * <p>
+ *
* @param useRemote The new useRemote value
*/
@Override
@@ -419,7 +419,7 @@ public class CompositeCacheAttributes
/**
* Dumps the core attributes.
- * <p>
+ *
* @return For debugging.
*/
@Override
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/behavior/ICompositeCacheAttributes.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/behavior/ICompositeCacheAttributes.java
index 33419719..48c02c69 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/behavior/ICompositeCacheAttributes.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/behavior/ICompositeCacheAttributes.java
@@ -117,7 +117,7 @@ public interface ICompositeCacheAttributes
boolean isUseLateral();
/**
- * Whether the memory cache should perform background memory shrinkage.
+ * Tests whether the memory cache should perform background memory
shrinkage.
* <p>
* @return The UseMemoryShrinker value
*/
@@ -219,7 +219,7 @@ public interface ICompositeCacheAttributes
void setUseDisk( boolean useDisk );
/**
- * set whether the cache should use a lateral cache
+ * Sets whether the cache should use a lateral cache
* <p>
* @param d
* The new useLateral value
@@ -227,7 +227,7 @@ public interface ICompositeCacheAttributes
void setUseLateral( boolean d );
/**
- * Whether the memory cache should perform background memory shrinkage.
+ * Sets whether the memory cache should perform background memory
shrinkage.
* <p>
* @param useShrinker
* The new UseMemoryShrinker value
