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/12/23 14:48:28 UTC
[commons-jcs] 01/01: Add @since tags
This is an automated email from the ASF dual-hosted git repository.
tv pushed a commit to branch release-3.1
in repository https://gitbox.apache.org/repos/asf/commons-jcs.git
commit e565e61eea41e1f37bdebd440a7024e28d0d52bd
Author: Thomas Vandahl <tv...@apache.org>
AuthorDate: Thu Dec 23 15:48:14 2021 +0100
Add @since tags
---
.../jcs3/auxiliary/disk/block/BlockDiskElementDescriptor.java | 2 ++
.../apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWait.java | 2 ++
.../commons/jcs3/auxiliary/lateral/LateralCacheNoWaitFacade.java | 4 ++++
.../commons/jcs3/auxiliary/lateral/LateralElementDescriptor.java | 6 ++++++
.../jcs3/auxiliary/lateral/behavior/ILateralCacheAttributes.java | 3 +++
.../jcs3/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java | 2 ++
.../auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListener.java | 3 +++
.../jcs3/auxiliary/lateral/socket/tcp/LateralTCPSender.java | 1 +
.../jcs3/auxiliary/lateral/socket/tcp/LateralTCPService.java | 1 +
.../auxiliary/lateral/socket/tcp/TCPLateralCacheAttributes.java | 2 ++
.../lateral/socket/tcp/behavior/ITCPLateralCacheAttributes.java | 2 ++
.../commons/jcs3/auxiliary/remote/RemoteCacheNoWaitFacade.java | 2 ++
.../jcs3/auxiliary/remote/server/RemoteCacheServerFactory.java | 1 +
.../main/java/org/apache/commons/jcs3/engine/CacheEventQueue.java | 1 +
.../org/apache/commons/jcs3/engine/PooledCacheEventQueue.java | 1 +
.../apache/commons/jcs3/engine/behavior/IElementSerializer.java | 6 ++++++
.../org/apache/commons/jcs3/engine/control/CompositeCache.java | 6 ++++--
.../apache/commons/jcs3/utils/discovery/DiscoveredService.java | 1 +
.../apache/commons/jcs3/utils/discovery/UDPDiscoveryManager.java | 1 +
.../apache/commons/jcs3/utils/discovery/UDPDiscoveryReceiver.java | 2 ++
.../apache/commons/jcs3/utils/discovery/UDPDiscoverySender.java | 2 ++
.../apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java | 8 ++++++++
.../main/java/org/apache/commons/jcs3/utils/net/HostNameUtil.java | 1 +
.../commons/jcs3/utils/serialization/CompressingSerializer.java | 1 +
.../commons/jcs3/utils/serialization/EncryptingSerializer.java | 2 ++
25 files changed, 61 insertions(+), 2 deletions(-)
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskElementDescriptor.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskElementDescriptor.java
index c74085e..d515eeb 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskElementDescriptor.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskElementDescriptor.java
@@ -58,6 +58,8 @@ public class BlockDiskElementDescriptor<K>
*
* @param key the key
* @param blocks the data
+ *
+ * @since 3.1
*/
public BlockDiskElementDescriptor(K key, int[] blocks)
{
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 7424c86..c4ddba4 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
@@ -110,6 +110,7 @@ public class LateralCacheNoWait<K, V>
* The identifying key to this no wait
*
* @return the identity key
+ * @since 3.1
*/
public String getIdentityKey()
{
@@ -120,6 +121,7 @@ public class LateralCacheNoWait<K, V>
* Set the identifying key to this no wait
*
* @param identityKey the identityKey to set
+ * @since 3.1
*/
public void setIdentityKey(String identityKey)
{
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWaitFacade.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWaitFacade.java
index 591ba2c..0ef7aa7 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWaitFacade.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWaitFacade.java
@@ -102,6 +102,7 @@ public class LateralCacheNoWaitFacade<K, V>
* @param listener the cache listener
* @param noWaits the list of noWaits
* @param cattr the configuration
+ * @since 3.1
*/
@SuppressWarnings("unchecked") // No generic arrays in java
public LateralCacheNoWaitFacade(final ILateralCacheListener<K, V> listener,
@@ -120,6 +121,7 @@ public class LateralCacheNoWaitFacade<K, V>
* Return the size of the no wait list (for testing)
*
* @return the noWait list size.
+ * @since 3.1
*/
protected int getNoWaitSize()
{
@@ -143,6 +145,7 @@ public class LateralCacheNoWaitFacade<K, V>
* <p>
* @param tcpServer the identifying key
* @return true if the noWait is in the list.
+ * @since 3.1
*/
public boolean containsNoWait(final String tcpServer)
{
@@ -199,6 +202,7 @@ public class LateralCacheNoWaitFacade<K, V>
* <p>
* @param tcpServer the identifying key.
* @return true if it was already in the array
+ * @since 3.1
*/
@SuppressWarnings("unchecked") // No generic arrays in java
public synchronized boolean removeNoWait(final String tcpServer)
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 8a421e7..5fb5838 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
@@ -72,6 +72,7 @@ public class LateralElementDescriptor<K, V>
* <p>
* @param ce ICacheElement<K, V> payload
* @param command operation requested by the client
+ * @since 3.1
*/
public LateralElementDescriptor( final ICacheElement<K, V> ce, LateralCommand command)
{
@@ -85,6 +86,7 @@ public class LateralElementDescriptor<K, V>
* @param ce ICacheElement<K, V> payload
* @param command operation requested by the client
* @param requesterId id of the the source of the request
+ * @since 3.1
*/
public LateralElementDescriptor( final ICacheElement<K, V> ce, LateralCommand command, long requesterId)
{
@@ -96,6 +98,7 @@ public class LateralElementDescriptor<K, V>
* Return payload
*
* @return the ce
+ * @since 3.1
*/
public ICacheElement<K, V> getPayload()
{
@@ -106,6 +109,7 @@ public class LateralElementDescriptor<K, V>
* Return id of the the source of the request
*
* @return the requesterId
+ * @since 3.1
*/
public long getRequesterId()
{
@@ -116,6 +120,7 @@ public class LateralElementDescriptor<K, V>
* Return operation requested by the client
*
* @return the command
+ * @since 3.1
*/
public LateralCommand getCommand()
{
@@ -124,6 +129,7 @@ public class LateralElementDescriptor<K, V>
/**
* @return the valHashCode
+ * @since 3.1
*/
public int getValHashCode()
{
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/behavior/ILateralCacheAttributes.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/behavior/ILateralCacheAttributes.java
index 93fece0..8930afd 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/behavior/ILateralCacheAttributes.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/behavior/ILateralCacheAttributes.java
@@ -51,6 +51,9 @@ public interface ILateralCacheAttributes
this.typeName = typeName;
}
+ /**
+ * @since 3.1
+ */
@Override
public String toString()
{
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java
index bc6d864..3ddae04 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java
@@ -239,6 +239,7 @@ public class LateralTCPCacheFactory
* @param elementSerializer the serializer to use when sending or receiving
*
* @return ICacheServiceNonLocal<K, V>
+ * @since 3.1
*/
// Need to cast because of common map for all cache services
@SuppressWarnings("unchecked")
@@ -292,6 +293,7 @@ public class LateralTCPCacheFactory
* Add cache instance to monitor
*
* @param cache the cache instance
+ * @since 3.1
*/
public void monitorCache(final LateralCacheNoWait<?, ?> cache)
{
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListener.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListener.java
index e24a684..9a0851c 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListener.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListener.java
@@ -94,6 +94,7 @@ public class LateralTCPDiscoveryListener
* @param cacheEventLogger Reference to the cache event logger for auxiliary cache creation
* @param elementSerializer Reference to the cache element serializer for auxiliary cache
* creation
+ * @since 3.1
*/
protected LateralTCPDiscoveryListener( final String factoryName,
final CompositeCacheManager cacheManager,
@@ -191,6 +192,7 @@ public class LateralTCPDiscoveryListener
* @param facade the related facade
* @return true if we found the no wait and added it. False if the no wait was not present or if
* we already had it.
+ * @since 3.1
*/
protected <K, V> boolean addNoWait(final LateralCacheNoWait<K, V> noWait,
final LateralCacheNoWaitFacade<K, V> facade)
@@ -235,6 +237,7 @@ public class LateralTCPDiscoveryListener
* @param cacheName
* @param tcpServer
* @return true if we found the no wait and removed it. False if the no wait was not present.
+ * @since 3.1
*/
protected <K, V> boolean removeNoWait(final LateralCacheNoWaitFacade<K, V> facade,
final String cacheName, final String tcpServer)
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPSender.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPSender.java
index 0696723..60fad67 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPSender.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPSender.java
@@ -81,6 +81,7 @@ public class LateralTCPSender
* @param lca the configuration object
* @param serializer the serializer to use when sending
* @throws IOException
+ * @since 3.1
*/
public LateralTCPSender( final ITCPLateralCacheAttributes lca, final IElementSerializer serializer )
throws IOException
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 b26c98f..75c6cd4 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
@@ -82,6 +82,7 @@ public class LateralTCPService<K, V>
* @param lca ITCPLateralCacheAttributes the configuration object
* @param serializer the serializer to use when sending
* @throws IOException
+ * @since 3.1
*/
public LateralTCPService( final ITCPLateralCacheAttributes lca, final IElementSerializer serializer )
throws IOException
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 b8fcacf..345cec7 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
@@ -262,6 +262,7 @@ public class TCPLateralCacheAttributes
* The time-to-live for the UDP multicast packets
* <p>
* @return Returns the udpTTL.
+ * @since 3.1
*/
@Override
public int getUdpTTL()
@@ -273,6 +274,7 @@ public class TCPLateralCacheAttributes
* Sets the time-to-live for the UDP multicast packet
* <p>
* @param udpTTL The udpTTL to set.
+ * @since 3.1
*/
@Override
public void setUdpTTL( final int udpTTL )
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 871e93c..7bec581 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
@@ -143,6 +143,7 @@ public interface ITCPLateralCacheAttributes
* The time-to-live for the UDP multicast packets
* <p>
* @return Returns the udpTTL.
+ * @since 3.1
*/
int getUdpTTL();
@@ -150,6 +151,7 @@ public interface ITCPLateralCacheAttributes
* Sets the time-to-live for the UDP multicast packet
* <p>
* @param udpTTL The udpTTL to set.
+ * @since 3.1
*/
void setUdpTTL( final int udpTTL );
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCacheNoWaitFacade.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCacheNoWaitFacade.java
index 3715d61..9f2e015 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCacheNoWaitFacade.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCacheNoWaitFacade.java
@@ -126,6 +126,8 @@ public class RemoteCacheNoWaitFacade<K, V>
* Connection in the background. If failovers are defined, the Failover runner
* will try to connect to a failover until the primary is restored.
* If no failovers are defined, this will exit automatically.
+ *
+ * @since 3.1
*/
protected void connectAndRestore()
{
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheServerFactory.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheServerFactory.java
index d1ff2a0..e0f5be9 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheServerFactory.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheServerFactory.java
@@ -168,6 +168,7 @@ public class RemoteCacheServerFactory
* @param registryHost - Hostname of the registry
* @param registryPort - the port on which to start the registry
* @param cacheEventLogger the event logger for error messages
+ * @since 3.1
*/
protected static void keepAlive(String registryHost, int registryPort, ICacheEventLogger cacheEventLogger)
{
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/CacheEventQueue.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/CacheEventQueue.java
index adb6a55..fcbcba2 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/CacheEventQueue.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/CacheEventQueue.java
@@ -63,6 +63,7 @@ public class CacheEventQueue<K, V>
* Create the thread pool.
* <p>
* @param threadPoolName
+ * @since 3.1
*/
@Override
protected ExecutorService createPool(final String threadPoolName)
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/PooledCacheEventQueue.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/PooledCacheEventQueue.java
index d3ae9d3..c0bc78e 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/PooledCacheEventQueue.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/PooledCacheEventQueue.java
@@ -98,6 +98,7 @@ public class PooledCacheEventQueue<K, V>
* Create the thread pool.
* <p>
* @param threadPoolName
+ * @since 3.1
*/
protected ExecutorService createPool(final String threadPoolName)
{
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/behavior/IElementSerializer.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/behavior/IElementSerializer.java
index 56fc2f5..5e78a38 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/behavior/IElementSerializer.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/behavior/IElementSerializer.java
@@ -72,6 +72,7 @@ public interface IElementSerializer
* @param os the output stream
* @return the number of bytes written
* @throws IOException if serialization or writing fails
+ * @since 3.1
*/
default <T> int serializeTo(T obj, OutputStream os)
throws IOException
@@ -95,6 +96,7 @@ public interface IElementSerializer
* @param oc the output channel
* @return the number of bytes written
* @throws IOException if serialization or writing fails
+ * @since 3.1
*/
default <T> int serializeTo(T obj, WritableByteChannel oc)
throws IOException
@@ -124,6 +126,7 @@ public interface IElementSerializer
* @param writeTimeoutMs the write timeout im milliseconds
* @return the number of bytes written
* @throws IOException if serialization or writing fails
+ * @since 3.1
*/
default <T> int serializeTo(T obj, AsynchronousByteChannel oc, int writeTimeoutMs)
throws IOException
@@ -161,6 +164,7 @@ public interface IElementSerializer
* @param loader class loader to use
* @throws IOException if serialization or reading fails
* @throws ClassNotFoundException thrown if we don't know the object.
+ * @since 3.1
*/
default <T> T deSerializeFrom(InputStream is, ClassLoader loader)
throws IOException, ClassNotFoundException
@@ -191,6 +195,7 @@ public interface IElementSerializer
* @param loader class loader to use
* @throws IOException if serialization or reading fails
* @throws ClassNotFoundException thrown if we don't know the object.
+ * @since 3.1
*/
default <T> T deSerializeFrom(ReadableByteChannel ic, ClassLoader loader)
throws IOException, ClassNotFoundException
@@ -230,6 +235,7 @@ public interface IElementSerializer
* @param loader class loader to use
* @throws IOException if serialization or reading fails
* @throws ClassNotFoundException thrown if we don't know the object.
+ * @since 3.1
*/
default <T> T deSerializeFrom(AsynchronousByteChannel ic, int readTimeoutMs, ClassLoader loader)
throws IOException, ClassNotFoundException
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCache.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCache.java
index f6ae9cd..cfb0563 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCache.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCache.java
@@ -197,6 +197,7 @@ public class CompositeCache<K, V>
* It filters out null caches
* <p>
* @param auxCaches
+ * @since 3.1
*/
public void setAuxCaches(final List<AuxiliaryCache<K, V>> auxCaches)
{
@@ -220,7 +221,8 @@ public class CompositeCache<K, V>
/**
* Get the list of auxiliary caches for this region.
* <p>
- * @return an array of auxiliary caches, may be empty, never null
+ * @return a list of auxiliary caches, may be empty, never null
+ * @since 3.1
*/
public List<AuxiliaryCache<K, V>> getAuxCacheList()
{
@@ -1231,7 +1233,7 @@ public class CompositeCache<K, V>
|| fromRemote && aux.getCacheType() == CacheType.REMOTE_CACHE)
{
log.info("In DISPOSE, [{0}] SKIPPING auxiliary [{1}] fromRemote [{2}]",
- this.cacheAttr::getCacheName,
+ this.cacheAttr::getCacheName,
() -> aux == null ? "null" : aux.getCacheName(),
() -> fromRemote);
continue;
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 57cabb3..5882bd8 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
@@ -59,6 +59,7 @@ public class DiscoveredService
* Constructor
*
* @param message incoming message
+ * @since 3.1
*/
public DiscoveredService(UDPDiscoveryMessage message)
{
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 3e17196..83d795b 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
@@ -99,6 +99,7 @@ public class UDPDiscoveryManager
* @param serializer
*
* @return UDPDiscoveryService
+ * @since 3.1
*/
public UDPDiscoveryService getService( final String discoveryAddress, final int discoveryPort,
final String serviceAddress, final int servicePort, final int updTTL,
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryReceiver.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryReceiver.java
index b5c0524..c82a05c 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryReceiver.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryReceiver.java
@@ -114,6 +114,7 @@ public class UDPDiscoveryReceiver
* @param multicastAddress
* @param multicastPort
* @throws IOException
+ * @since 3.1
*/
public UDPDiscoveryReceiver( final UDPDiscoveryService service,
final String multicastInterfaceString,
@@ -324,6 +325,7 @@ public class UDPDiscoveryReceiver
* For testing
*
* @param serializer the serializer to set
+ * @since 3.1
*/
protected void setSerializer(IElementSerializer serializer)
{
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySender.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySender.java
index 2375be1..d4cb479 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySender.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySender.java
@@ -87,6 +87,7 @@ public class UDPDiscoverySender implements AutoCloseable
* @param udpDiscoveryAttributes configuration object
* @param serializer the Serializer to use when sending messages
* @throws IOException
+ * @since 3.1
*/
public UDPDiscoverySender(final UDPDiscoveryAttributes udpDiscoveryAttributes, final IElementSerializer serializer)
throws IOException
@@ -111,6 +112,7 @@ public class UDPDiscoverySender implements AutoCloseable
* @param udpTTL the Datagram packet time-to-live
* @param serializer the Serializer to use when sending messages
* @throws IOException
+ * @since 3.1
*/
public UDPDiscoverySender(final String mcastInterface, final String host,
final int port, final int udpTTL, IElementSerializer serializer)
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java
index 0260b00..4f53cf5 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java
@@ -109,6 +109,7 @@ public class UDPDiscoveryService
*
* @param attributes settings of service
* @param serializer the serializer to use to send and receive messages
+ * @since 3.1
*/
public UDPDiscoveryService(final UDPDiscoveryAttributes attributes, IElementSerializer serializer)
{
@@ -222,6 +223,8 @@ public class UDPDiscoveryService
/**
* This goes through the list of services and removes those that we haven't heard from in longer
* than the max idle time.
+ *
+ * @since 3.1
*/
protected void cleanup()
{
@@ -247,6 +250,8 @@ public class UDPDiscoveryService
/**
* Initial request that the other caches let it know their addresses.
+ *
+ * @since 3.1
*/
public void initiateBroadcast()
{
@@ -301,6 +306,8 @@ public class UDPDiscoveryService
/**
* Issues a remove broadcast to the others.
+ *
+ * @since 3.1
*/
protected void shutdownBroadcast()
{
@@ -415,6 +422,7 @@ public class UDPDiscoveryService
* Return the serializer implementation
*
* @return the serializer
+ * @since 3.1
*/
public IElementSerializer getSerializer()
{
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/net/HostNameUtil.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/net/HostNameUtil.java
index f06cab3..5dcc62b 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/net/HostNameUtil.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/net/HostNameUtil.java
@@ -97,6 +97,7 @@ public class HostNameUtil
* <p>
* @return InetAddress
* @throws UnknownHostException If the LAN address of the machine cannot be found.
+ * @since 3.1
*/
public static InetAddress getLocalHostLANAddress()
throws UnknownHostException
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/serialization/CompressingSerializer.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/serialization/CompressingSerializer.java
index efb7f20..4f8185e 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/serialization/CompressingSerializer.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/serialization/CompressingSerializer.java
@@ -45,6 +45,7 @@ public class CompressingSerializer extends StandardSerializer
* Wrapper constructor
*
* @param serializer the wrapped serializer
+ * @since 3.1
*/
public CompressingSerializer(IElementSerializer serializer)
{
diff --git a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/serialization/EncryptingSerializer.java b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/serialization/EncryptingSerializer.java
index 01eecaf..3137bb5 100644
--- a/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/serialization/EncryptingSerializer.java
+++ b/commons-jcs-core/src/main/java/org/apache/commons/jcs3/utils/serialization/EncryptingSerializer.java
@@ -37,6 +37,8 @@ import org.apache.commons.jcs3.engine.behavior.IElementSerializer;
/**
* Performs serialization and de-serialization. It encrypts and decrypts the
* value.
+ *
+ * @since 3.1
*/
public class EncryptingSerializer extends StandardSerializer
{