This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 a83d8ead Javadoc
a83d8ead is described below
commit a83d8ead92c2fd3a51590974fecb6f0b0bf04530
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:50:11 2026 -0400
Javadoc
---
.../commons/jcs4/access/AbstractCacheAccess.java | 4 ++--
.../access/behavior/ICacheAccessManagement.java | 2 +-
.../jcs4/access/behavior/IGroupCacheAccess.java | 2 +-
.../jcs4/auxiliary/AbstractAuxiliaryCache.java | 2 +-
.../auxiliary/AbstractCacheEventLogSupport.java | 2 +-
.../commons/jcs4/auxiliary/AuxiliaryCache.java | 2 +-
.../jcs4/auxiliary/disk/AbstractDiskCache.java | 2 +-
.../disk/AbstractDiskCacheAttributes.java | 4 ++--
.../disk/behavior/IDiskCacheAttributes.java | 2 +-
.../jcs4/auxiliary/disk/block/BlockDisk.java | 20 +++++++++---------
.../disk/block/BlockDiskCacheAttributes.java | 6 +++---
.../auxiliary/disk/block/BlockDiskKeyStore.java | 2 +-
.../jcs4/auxiliary/disk/indexed/IndexedDisk.java | 4 ++--
.../auxiliary/disk/indexed/IndexedDiskCache.java | 4 ++--
.../disk/indexed/IndexedDiskCacheAttributes.java | 4 ++--
.../jcs4/auxiliary/disk/jdbc/JDBCDiskCache.java | 12 +++++------
.../disk/jdbc/JDBCDiskCacheAttributes.java | 24 +++++++++++-----------
.../auxiliary/disk/jdbc/JDBCDiskCacheFactory.java | 2 +-
.../jcs4/auxiliary/disk/jdbc/ShrinkerThread.java | 2 +-
.../jcs4/auxiliary/disk/jdbc/TableState.java | 2 +-
.../disk/jdbc/dsfactory/DataSourceFactory.java | 4 ++--
.../disk/jdbc/dsfactory/JndiDataSourceFactory.java | 2 +-
.../dsfactory/SharedPoolDataSourceFactory.java | 2 +-
.../auxiliary/disk/jdbc/mysql/MySQLDiskCache.java | 2 +-
.../disk/jdbc/mysql/MySQLDiskCacheAttributes.java | 4 ++--
.../disk/jdbc/mysql/MySQLTableOptimizer.java | 2 +-
.../lateral/behavior/ILateralCacheListener.java | 2 +-
.../lateral/socket/tcp/LateralTCPCache.java | 2 +-
.../socket/tcp/LateralTCPCacheAttributes.java | 18 ++++++++--------
.../lateral/socket/tcp/LateralTCPCacheFactory.java | 2 +-
.../lateral/socket/tcp/LateralTCPCacheNoWait.java | 4 ++--
.../socket/tcp/LateralTCPCacheNoWaitFacade.java | 2 +-
.../lateral/socket/tcp/LateralTCPListener.java | 8 ++++----
.../lateral/socket/tcp/LateralTCPService.java | 2 +-
.../tcp/behavior/ILateralTCPCacheAttributes.java | 16 +++++++--------
.../remote/AbstractRemoteAuxiliaryCache.java | 6 +++---
.../remote/AbstractRemoteCacheNoWaitFacade.java | 2 +-
.../remote/CommonRemoteCacheAttributes.java | 2 +-
.../commons/jcs4/auxiliary/remote/RemoteCache.java | 2 +-
.../auxiliary/remote/RemoteCacheAttributes.java | 6 +++---
.../jcs4/auxiliary/remote/RemoteCacheManager.java | 2 +-
.../jcs4/auxiliary/remote/RemoteCacheNoWait.java | 2 +-
.../jcs4/auxiliary/remote/RemoteLocation.java | 2 +-
.../commons/jcs4/auxiliary/remote/RemoteUtils.java | 6 +++---
.../remote/behavior/IRemoteCacheAttributes.java | 8 ++++----
.../remote/behavior/IRemoteCacheListener.java | 2 +-
.../remote/http/client/AbstractHttpClient.java | 4 ++--
.../http/client/RemoteHttpCacheAttributes.java | 18 ++++++++--------
.../remote/http/client/RemoteHttpCacheClient.java | 6 +++---
.../remote/http/client/RemoteHttpCacheFactory.java | 2 +-
.../http/server/AbstractRemoteCacheService.java | 4 ++--
.../auxiliary/remote/server/RemoteCacheServer.java | 2 +-
.../remote/server/RemoteCacheServerAttributes.java | 4 ++--
.../remote/server/RemoteCacheServerFactory.java | 6 +++---
.../TimeoutConfigurableRMISocketFactory.java | 4 ++--
.../behavior/IRemoteCacheServerAttributes.java | 4 ++--
.../jcs4/engine/AbstractCacheEventQueue.java | 2 +-
.../commons/jcs4/engine/PooledCacheEventQueue.java | 2 +-
.../jcs4/engine/behavior/ICacheEventQueue.java | 2 +-
.../jcs4/engine/behavior/ICacheService.java | 2 +-
.../engine/behavior/ICompositeCacheAttributes.java | 2 +-
.../engine/behavior/ICompositeCacheManager.java | 2 +-
.../jcs4/engine/behavior/IElementSerializer.java | 6 +++---
.../jcs4/engine/behavior/IProvideScheduler.java | 2 +-
.../jcs4/engine/control/CompositeCache.java | 10 ++++-----
.../jcs4/engine/control/CompositeCacheManager.java | 12 +++++------
.../control/event/behavior/IElementEvent.java | 2 +-
.../jcs4/engine/control/group/GroupAttrName.java | 2 +-
.../commons/jcs4/engine/control/group/GroupId.java | 2 +-
.../jcs4/engine/logging/behavior/ICacheEvent.java | 10 ++++-----
.../AbstractDoubleLinkedListMemoryCache.java | 2 +-
.../jcs4/engine/memory/behavior/IMemoryCache.java | 2 +-
.../memory/util/MemoryElementDescriptor.java | 2 +-
.../util/SoftReferenceElementDescriptor.java | 2 +-
.../apache/commons/jcs4/engine/stats/Stats.java | 2 +-
.../jcs4/engine/stats/behavior/IStatElement.java | 2 +-
.../main/java/org/apache/commons/jcs4/log/Log.java | 4 ++--
.../apache/commons/jcs4/log/MessageFormatter.java | 4 ++--
.../apache/commons/jcs4/log/SystemLogAdapter.java | 2 +-
.../commons/jcs4/utils/config/OptionConverter.java | 2 +-
.../jcs4/utils/discovery/DiscoveredService.java | 8 ++++----
.../jcs4/utils/discovery/UDPDiscoveryMessage.java | 10 ++++-----
.../jcs4/utils/discovery/UDPDiscoveryReceiver.java | 2 +-
.../jcs4/utils/discovery/UDPDiscoveryService.java | 4 ++--
.../jcs4/utils/struct/LRUElementDescriptor.java | 2 +-
.../commons/jcs4/utils/timing/ElapsedTimer.java | 2 +-
.../jcs4/auxiliary/MockCacheEventLogger.java | 2 +-
.../remote/server/MockRMISocketFactory.java | 2 +-
.../engine/control/MockCompositeCacheManager.java | 4 ++--
.../control/event/ElementEventHandlerMockImpl.java | 12 +++++------
.../control/event/SimpleEventHandlingUnitTest.java | 10 ++++-----
.../jcs/auxiliary/disk/file/FileDiskCache.java | 4 ++--
.../disk/file/FileDiskCacheAttributes.java | 8 ++++----
.../commons/jcs/access/PartitionedCacheAccess.java | 10 ++++-----
.../jcs/utils/props/AbstractPropertyContainer.java | 8 ++++----
.../commons/jcs/yajcache/file/CacheFileDAO.java | 2 +-
.../http/broadcast/LateralCacheUnicaster.java | 2 +-
.../jcs/engine/memory/arc/ARCMemoryCache.java | 2 +-
98 files changed, 223 insertions(+), 223 deletions(-)
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/AbstractCacheAccess.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/AbstractCacheAccess.java
index 84aa527f..6275d184 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/AbstractCacheAccess.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/AbstractCacheAccess.java
@@ -96,7 +96,7 @@ public abstract class AbstractCacheAccess<K, V>
* used items. These will be spooled to disk if a disk auxiliary is
available.
*
* @param numberToFree
- * @return the number that were removed. if you ask to free 5, but there
are only 3, you will
+ * @return The number that were removed. if you ask to free 5, but there
are only 3, you will
* get 3.
* @throws CacheException
*/
@@ -140,7 +140,7 @@ public abstract class AbstractCacheAccess<K, V>
* Each time an element is added to the cache without element attributes,
the default element
* attributes are cloned.
*
- * @return the default element attributes used by this region.
+ * @return The default element attributes used by this region.
* @throws CacheException
*/
@Override
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/behavior/ICacheAccessManagement.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/behavior/ICacheAccessManagement.java
index a85de654..49d73964 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/behavior/ICacheAccessManagement.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/behavior/ICacheAccessManagement.java
@@ -50,7 +50,7 @@ public interface ICacheAccessManagement
* used items. These will be spooled to disk if a disk auxiliary is
available.
*
* @param numberToFree
- * @return the number that were removed. if you ask to free 5, but there
are only 3, you will
+ * @return The number that were removed. if you ask to free 5, but there
are only 3, you will
* get 3.
* @throws CacheException
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/behavior/IGroupCacheAccess.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/behavior/IGroupCacheAccess.java
index 307cc1ce..c2e7e4b7 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/behavior/IGroupCacheAccess.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/behavior/IGroupCacheAccess.java
@@ -45,7 +45,7 @@ public interface IGroupCacheAccess<K, V>
* Gets the set of keys of objects currently in the group
*
* @param group
- * @return the set of group keys.
+ * @return The set of group keys.
*/
Set<K> getGroupKeys( String group );
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractAuxiliaryCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractAuxiliaryCache.java
index 46c4b97a..adcdd058 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractAuxiliaryCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractAuxiliaryCache.java
@@ -90,7 +90,7 @@ public abstract class AbstractAuxiliaryCache<K, V>
/**
* Gets the extra info for the event log.
*
- * @return the eventLogSourceName
+ * @return The eventLogSourceName
*/
@Override
protected String getEventLogSourceName()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractCacheEventLogSupport.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractCacheEventLogSupport.java
index 1f7666a6..e87a239b 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractCacheEventLogSupport.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractCacheEventLogSupport.java
@@ -111,7 +111,7 @@ public abstract class AbstractCacheEventLogSupport<K, V>
/**
* Gets the extra info for the event log.
*
- * @return the eventLogSourceName
+ * @return The eventLogSourceName
*/
protected abstract String getEventLogSourceName();
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AuxiliaryCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AuxiliaryCache.java
index e6f730ae..6c1c1e5e 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AuxiliaryCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AuxiliaryCache.java
@@ -37,7 +37,7 @@ public interface AuxiliaryCache<K, V>
* This returns the generic attributes for an auxiliary cache. Most
implementations will cast
* this to a more specific type.
*
- * @return the attributes for the auxiliary cache
+ * @return The attributes for the auxiliary cache
*/
AuxiliaryCacheAttributes getAuxiliaryCacheAttributes();
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/AbstractDiskCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/AbstractDiskCache.java
index 313e3adf..75ef2ad0 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/AbstractDiskCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/AbstractDiskCache.java
@@ -453,7 +453,7 @@ public abstract class AbstractDiskCache<K, V>
*/
/**
- * @return the status -- alive or disposed from CacheConstants
+ * @return The status -- alive or disposed from CacheConstants
* @see ICache#getStatus
*/
@Override
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/AbstractDiskCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/AbstractDiskCacheAttributes.java
index 571b9e61..d4aa8ecf 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/AbstractDiskCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/AbstractDiskCacheAttributes.java
@@ -93,7 +93,7 @@ public abstract class AbstractDiskCacheAttributes extends
AbstractAuxiliaryCache
* for a particular region.
* <p>
*
- * @return the time.
+ * @return The time.
*/
@Override
public Duration getShutdownSpoolTimeLimit()
@@ -102,7 +102,7 @@ public abstract class AbstractDiskCacheAttributes extends
AbstractAuxiliaryCache
}
/**
- * @return the allowRemoveAll.
+ * @return The allowRemoveAll.
*/
@Override
public boolean isAllowRemoveAll()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/behavior/IDiskCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/behavior/IDiskCacheAttributes.java
index 2c85cd98..4d0b1dfa 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/behavior/IDiskCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/behavior/IDiskCacheAttributes.java
@@ -67,7 +67,7 @@ public interface IDiskCacheAttributes
* Gets the amount of time we will wait for elements to move to
* disk during shutdown for a particular region.
*
- * @return the time.
+ * @return The time.
*/
Duration getShutdownSpoolTimeLimit();
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDisk.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDisk.java
index 9f60bb03..e5ef019b 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDisk.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDisk.java
@@ -124,7 +124,7 @@ public class BlockDisk implements AutoCloseable
* Calculates the file offset for a particular block.
*
* @param block number
- * @return the byte offset for this block in the file as a long
+ * @return The byte offset for this block in the file as a long
* @since 2.0
*/
protected long calculateByteOffsetForBlockAsLong(final int block)
@@ -136,7 +136,7 @@ public class BlockDisk implements AutoCloseable
* The number of blocks needed.
*
* @param data
- * @return the number of blocks needed to store the byte array
+ * @return The number of blocks needed to store the byte array
*/
protected int calculateTheNumberOfBlocksNeeded(final byte[] data)
{
@@ -190,7 +190,7 @@ public class BlockDisk implements AutoCloseable
}
/**
- * @return the average size of the an element inserted.
+ * @return The average size of the an element inserted.
*/
protected long getAveragePutSizeBytes()
{
@@ -241,7 +241,7 @@ public class BlockDisk implements AutoCloseable
}
/**
- * @return the blockSizeBytes.
+ * @return The blockSizeBytes.
*/
protected int getBlockSizeBytes()
{
@@ -249,7 +249,7 @@ public class BlockDisk implements AutoCloseable
}
/**
- * @return the number of empty blocks.
+ * @return The number of empty blocks.
*/
protected int getEmptyBlocks()
{
@@ -259,7 +259,7 @@ public class BlockDisk implements AutoCloseable
/**
* This is used for debugging.
*
- * @return the file path.
+ * @return The file path.
*/
protected String getFilePath()
{
@@ -267,7 +267,7 @@ public class BlockDisk implements AutoCloseable
}
/**
- * @return the numberOfBlocks.
+ * @return The numberOfBlocks.
*/
protected int getNumberOfBlocks()
{
@@ -277,7 +277,7 @@ public class BlockDisk implements AutoCloseable
/**
* Returns the file length.
*
- * @return the size of the file.
+ * @return The size of the file.
* @throws IOException
*/
protected long length()
@@ -290,7 +290,7 @@ public class BlockDisk implements AutoCloseable
* Reads an object that is located in the specified blocks.
*
* @param blockNumbers
- * @return the object instance
+ * @return The object instance
* @throws IOException
* @throws ClassNotFoundException
*/
@@ -428,7 +428,7 @@ public class BlockDisk implements AutoCloseable
* <li>If the process fails we should decrement the block count if we took
from it.</li>
* </ol>
* @param object
- * @return the blocks we used.
+ * @return The blocks we used.
* @throws IOException
*/
protected <T> int[] write(final T object)
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDiskCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDiskCacheAttributes.java
index 6ffba82e..80c778de 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDiskCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDiskCacheAttributes.java
@@ -51,7 +51,7 @@ public class BlockDiskCacheAttributes
private Duration keyPersistenceInterval = DEFAULT_KEY_PERSISTENCE_INTERVAL;
/**
- * @return the blockSizeBytes.
+ * @return The blockSizeBytes.
*/
public int getBlockSizeBytes()
{
@@ -59,7 +59,7 @@ public class BlockDiskCacheAttributes
}
/**
- * @return the keyPersistenceInterval.
+ * @return The keyPersistenceInterval.
*/
public Duration getKeyPersistenceInterval()
{
@@ -67,7 +67,7 @@ public class BlockDiskCacheAttributes
}
/**
- * @return the maxKeySize.
+ * @return The maxKeySize.
*/
public int getMaxKeySize()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDiskKeyStore.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDiskKeyStore.java
index 850dbc12..86323b53 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDiskKeyStore.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDiskKeyStore.java
@@ -557,7 +557,7 @@ public class BlockDiskKeyStore<K>
* Gets the size of the key hash.
* <p>
*
- * @return the number of keys.
+ * @return The number of keys.
*/
public int size()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDisk.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDisk.java
index 4540cf9a..32761900 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDisk.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDisk.java
@@ -79,7 +79,7 @@ public class IndexedDisk implements AutoCloseable
/**
* This is used for debugging.
*
- * @return the file path.
+ * @return The file path.
*/
protected String getFilePath()
{
@@ -100,7 +100,7 @@ public class IndexedDisk implements AutoCloseable
/**
* Returns the raf length.
*
- * @return the length of the file.
+ * @return The length of the file.
* @throws IOException If an I/O error occurs.
*/
protected long length()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDiskCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDiskCache.java
index a0969e54..c6ca4f46 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDiskCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDiskCache.java
@@ -732,7 +732,7 @@ public class IndexedDiskCache<K, V> extends
AbstractDiskCache<K, V>
* This is for debugging and testing.
* <p>
*
- * @return the length of the data file.
+ * @return The length of the data file.
* @throws IOException
*/
protected long getDataFileSize() throws IOException
@@ -878,7 +878,7 @@ public class IndexedDiskCache<K, V> extends
AbstractDiskCache<K, V>
* This is exposed for testing.
* <p>
*
- * @return the timesOptimized.
+ * @return The timesOptimized.
*/
protected int getTimesOptimized()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDiskCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDiskCacheAttributes.java
index 738b6299..702df3a0 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDiskCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDiskCacheAttributes.java
@@ -79,7 +79,7 @@ public class IndexedDiskCacheAttributes
}
/**
- * @return the clearDiskOnStartup
+ * @return The clearDiskOnStartup
*/
public boolean isClearDiskOnStartup()
{
@@ -87,7 +87,7 @@ public class IndexedDiskCacheAttributes
}
/**
- * @return the optimizeOnShutdown.
+ * @return The optimizeOnShutdown.
*/
public boolean isOptimizeOnShutdown()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCache.java
index 23241f54..3a9a8084 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCache.java
@@ -169,7 +169,7 @@ public class JDBCDiskCache<K, V>
/**
* Removed the expired. (now - create time) > max life
*
- * @return the number deleted
+ * @return The number deleted
*/
protected int deleteExpired()
{
@@ -264,7 +264,7 @@ public class JDBCDiskCache<K, V>
/**
* Public so managers can access it.
- * @return the dsFactory
+ * @return The dsFactory
* @throws SQLException if getting a data source fails
*/
public DataSource getDataSource() throws SQLException
@@ -275,7 +275,7 @@ public class JDBCDiskCache<K, V>
/**
* This is used by the event logging.
*
- * @return the location of the disk, either path or ip.
+ * @return The location of the disk, either path or ip.
*/
@Override
protected String getEventLoggingExtraInfo()
@@ -284,7 +284,7 @@ public class JDBCDiskCache<K, V>
}
/**
- * @return the jdbcDiskCacheAttributes.
+ * @return The jdbcDiskCacheAttributes.
*/
protected JDBCDiskCacheAttributes getJdbcDiskCacheAttributes()
{
@@ -361,7 +361,7 @@ public class JDBCDiskCache<K, V>
/**
* Returns the name of the table.
*
- * @return the table name or UNDEFINED
+ * @return The table name or UNDEFINED
*/
protected String getTableName()
{
@@ -370,7 +370,7 @@ public class JDBCDiskCache<K, V>
}
/**
- * @return the tableState.
+ * @return The tableState.
*/
public TableState getTableState()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheAttributes.java
index 42e77576..66511e75 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheAttributes.java
@@ -92,7 +92,7 @@ public class JDBCDiskCacheAttributes
private String connectionPoolName;
/**
- * @return the connectionPoolName
+ * @return The connectionPoolName
*/
public String getConnectionPoolName()
{
@@ -100,7 +100,7 @@ public class JDBCDiskCacheAttributes
}
/**
- * @return the driverClassName.
+ * @return The driverClassName.
*/
public String getDriverClassName()
{
@@ -108,7 +108,7 @@ public class JDBCDiskCacheAttributes
}
/**
- * @return the jndiPath
+ * @return The jndiPath
*/
public String getJndiPath()
{
@@ -116,7 +116,7 @@ public class JDBCDiskCacheAttributes
}
/**
- * @return the jndiTTL
+ * @return The jndiTTL
*/
public Duration getJndiTTL()
{
@@ -124,7 +124,7 @@ public class JDBCDiskCacheAttributes
}
/**
- * @return the maxTotal.
+ * @return The maxTotal.
*/
public int getMaxTotal()
{
@@ -132,7 +132,7 @@ public class JDBCDiskCacheAttributes
}
/**
- * @return the password.
+ * @return The password.
*/
public String getPassword()
{
@@ -140,7 +140,7 @@ public class JDBCDiskCacheAttributes
}
/**
- * @return the shrinkerInterval.
+ * @return The shrinkerInterval.
*/
public Duration getShrinkerInterval()
{
@@ -148,7 +148,7 @@ public class JDBCDiskCacheAttributes
}
/**
- * @return the tableName.
+ * @return The tableName.
*/
public String getTableName()
{
@@ -156,7 +156,7 @@ public class JDBCDiskCacheAttributes
}
/**
- * @return the url.
+ * @return The url.
*/
public String getUrl()
{
@@ -164,7 +164,7 @@ public class JDBCDiskCacheAttributes
}
/**
- * @return the userName.
+ * @return The userName.
*/
public String getUserName()
{
@@ -172,7 +172,7 @@ public class JDBCDiskCacheAttributes
}
/**
- * @return the testBeforeInsert.
+ * @return The testBeforeInsert.
*/
public boolean isTestBeforeInsert()
{
@@ -180,7 +180,7 @@ public class JDBCDiskCacheAttributes
}
/**
- * @return the useDiskShrinker.
+ * @return The useDiskShrinker.
*/
public boolean isUseDiskShrinker()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java
index 2927e148..b0f86835 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java
@@ -222,7 +222,7 @@ public class JDBCDiskCacheFactory
/**
* Gets the scheduler service
*
- * @return the scheduler
+ * @return The scheduler
*/
protected ScheduledExecutorService getScheduledExecutorService()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/ShrinkerThread.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/ShrinkerThread.java
index 90aad8a4..637d82ef 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/ShrinkerThread.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/ShrinkerThread.java
@@ -111,7 +111,7 @@ public class ShrinkerThread
* How long should we wait between calls to deleteExpired when we are
iterating through the list
* of regions.
*
- * @return the pauseBetweenRegionCalls.
+ * @return The pauseBetweenRegionCalls.
*/
public Duration getPauseBetweenRegionCalls()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/TableState.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/TableState.java
index f1dc91bc..5c2d490b 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/TableState.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/TableState.java
@@ -65,7 +65,7 @@ public class TableState
}
/**
- * @return the state.
+ * @return The state.
*/
public TableStateType getState()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/DataSourceFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/DataSourceFactory.java
index a80676b5..87eb3139 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/DataSourceFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/DataSourceFactory.java
@@ -58,13 +58,13 @@ public interface DataSourceFactory
throws SQLException;
/**
- * @return the {@code DataSource} configured by the factory.
+ * @return The {@code DataSource} configured by the factory.
* @throws SQLException if the source can't be returned
*/
DataSource getDataSource() throws SQLException;
/**
- * @return the name of the factory.
+ * @return The name of the factory.
*/
String getName();
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/JndiDataSourceFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/JndiDataSourceFactory.java
index 20790397..186e901b 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/JndiDataSourceFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/JndiDataSourceFactory.java
@@ -116,7 +116,7 @@ public class JndiDataSourceFactory implements
DataSourceFactory
}
/**
- * @return the name of the factory.
+ * @return The name of the factory.
*/
@Override
public String getName()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java
index 5364dc1b..437895ed 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java
@@ -123,7 +123,7 @@ public class SharedPoolDataSourceFactory implements
DataSourceFactory
}
/**
- * @return the name of the factory.
+ * @return The name of the factory.
*/
@Override
public String getName()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLDiskCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLDiskCache.java
index 9691e01e..7c877b19 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLDiskCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLDiskCache.java
@@ -71,7 +71,7 @@ public class MySQLDiskCache<K, V>
* <p>
* TODO consider blocking and trying again.
*
- * @return the number deleted
+ * @return The number deleted
*/
@Override
protected int deleteExpired()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLDiskCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLDiskCacheAttributes.java
index 90ae5e07..0021dbe5 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLDiskCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLDiskCacheAttributes.java
@@ -54,7 +54,7 @@ public class MySQLDiskCacheAttributes
private boolean balkDuringOptimization = DEFAULT_BALK_DURING_OPTIMIZATION;
/**
- * @return the optimizationSchedule.
+ * @return The optimizationSchedule.
*/
public String getOptimizationSchedule()
{
@@ -64,7 +64,7 @@ public class MySQLDiskCacheAttributes
/**
* Should we return null while optimizing the table.
*
- * @return the balkDuringOptimization.
+ * @return The balkDuringOptimization.
*/
public boolean isBalkDuringOptimization()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLTableOptimizer.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLTableOptimizer.java
index 760c238a..19ba5a68 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLTableOptimizer.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLTableOptimizer.java
@@ -69,7 +69,7 @@ public class MySQLTableOptimizer
}
/**
- * @return the tableName.
+ * @return The tableName.
*/
public String getTableName()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/behavior/ILateralCacheListener.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/behavior/ILateralCacheListener.java
index 5b604667..b2a065ac 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/behavior/ILateralCacheListener.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/behavior/ILateralCacheListener.java
@@ -34,7 +34,7 @@ public interface ILateralCacheListener<K, V>
void dispose();
/**
- * @return the cacheMgr.
+ * @return The cacheMgr.
*/
ICompositeCacheManager getCacheManager();
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCache.java
index f1a8f375..43c3db3b 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCache.java
@@ -99,7 +99,7 @@ public class LateralTCPCache<K, V>
}
/**
- * @return the AuxiliaryCacheAttributes.
+ * @return The AuxiliaryCacheAttributes.
*/
@Override
public ILateralTCPCacheAttributes getAuxiliaryCacheAttributes()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheAttributes.java
index ecfe0d96..215a2705 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheAttributes.java
@@ -121,7 +121,7 @@ public class LateralTCPCacheAttributes
private int zombieQueueMaxSize = DEFAULT_ZOMBIE_QUEUE_MAX_SIZE;
/**
- * @return the openTimeOut
+ * @return The openTimeOut
*/
@Override
public Duration getOpenTimeOut()
@@ -130,7 +130,7 @@ public class LateralTCPCacheAttributes
}
/**
- * @return the socketTimeOut
+ * @return The socketTimeOut
*/
@Override
public Duration getSocketTimeOut()
@@ -185,7 +185,7 @@ public class LateralTCPCacheAttributes
/**
* The address to broadcast to if UDPDiscovery is enabled.
*
- * @return the udpDiscoveryAddr.
+ * @return The udpDiscoveryAddr.
*/
@Override
public String getUdpDiscoveryAddr()
@@ -196,7 +196,7 @@ public class LateralTCPCacheAttributes
/**
* The UDP discovery network interface if UDPDiscovery is enabled.
*
- * @return the udpDiscoveryInterface.
+ * @return The udpDiscoveryInterface.
*/
@Override
public String getUdpDiscoveryInterface()
@@ -207,7 +207,7 @@ public class LateralTCPCacheAttributes
/**
* The port to use if UDPDiscovery is enabled.
*
- * @return the udpDiscoveryPort.
+ * @return The udpDiscoveryPort.
*/
@Override
public int getUdpDiscoveryPort()
@@ -218,7 +218,7 @@ public class LateralTCPCacheAttributes
/**
* The time-to-live for the UDP multicast packets
*
- * @return the udpTTL.
+ * @return The udpTTL.
* @since 3.1
*/
@Override
@@ -280,7 +280,7 @@ public class LateralTCPCacheAttributes
/**
* Tests whether or not TCP laterals can try to find each other by
multicast communication.
*
- * @return the udpDiscoveryEnabled.
+ * @return The udpDiscoveryEnabled.
*/
@Override
public boolean isUdpDiscoveryEnabled()
@@ -449,7 +449,7 @@ public class LateralTCPCacheAttributes
* The number of elements the zombie queue will hold. This queue is used
to store events if we
* loose our connection with the server.
*
- * @return the zombieQueueMaxSize.
+ * @return The zombieQueueMaxSize.
*/
@Override
public int getZombieQueueMaxSize()
@@ -458,7 +458,7 @@ public class LateralTCPCacheAttributes
}
/**
- * @return the receive.
+ * @return The receive.
*/
@Override
public boolean isReceive()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java
index fd3ff536..cc72f434 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java
@@ -65,7 +65,7 @@ public class LateralTCPCacheFactory
* @param attr ILateralTCPCacheAttributes
* @param cacheMgr the composite cache manager
* @param serializer the serializer to use when receiving
- * @return the listener if created, else null
+ * @return The listener if created, else null
*/
private static <K, V> ILateralCacheListener<K, V> createListener( final
ILateralTCPCacheAttributes attr,
final ICompositeCacheManager cacheMgr, final IElementSerializer
elementSerializer )
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWait.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWait.java
index f1ee3ddc..ddf22290 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWait.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWait.java
@@ -168,7 +168,7 @@ public class LateralTCPCacheNoWait<K, V>
}
/**
- * @return the AuxiliaryCacheAttributes.
+ * @return The AuxiliaryCacheAttributes.
*/
@Override
public ILateralTCPCacheAttributes getAuxiliaryCacheAttributes()
@@ -201,7 +201,7 @@ public class LateralTCPCacheNoWait<K, V>
/**
* The identifying key to this no wait
*
- * @return the identity key
+ * @return The identity key
* @since 3.1
*/
public String getIdentityKey()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWaitFacade.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWaitFacade.java
index 121395bc..0163d10a 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWaitFacade.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWaitFacade.java
@@ -239,7 +239,7 @@ public class LateralTCPCacheNoWaitFacade<K, V>
/**
* Return the size of the no wait list (for testing)
*
- * @return the noWait list size.
+ * @return The noWait list size.
* @since 3.1
*/
protected int getNoWaitSize()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPListener.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPListener.java
index 021c861b..81ef6276 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPListener.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPListener.java
@@ -160,7 +160,7 @@ public class LateralTCPListener<K, V>
}
/**
- * @return the cacheMgr.
+ * @return The cacheMgr.
*/
@Override
public ICompositeCacheManager getCacheManager()
@@ -169,7 +169,7 @@ public class LateralTCPListener<K, V>
}
/**
- * @return the getCnt.
+ * @return The getCnt.
*/
protected int getGetCnt()
{
@@ -192,7 +192,7 @@ public class LateralTCPListener<K, V>
/**
* This is roughly the number of updates the lateral has received.
*
- * @return the putCnt.
+ * @return The putCnt.
*/
protected int getPutCnt()
{
@@ -200,7 +200,7 @@ public class LateralTCPListener<K, V>
}
/**
- * @return the removeCnt.
+ * @return The removeCnt.
*/
protected int getRemoveCnt()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPService.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPService.java
index 52c79820..7de88653 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPService.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPService.java
@@ -165,7 +165,7 @@ public class LateralTCPService<K, V>
}
/**
- * @return the listernId.
+ * @return The listernId.
*/
protected long getListenerId()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/behavior/ILateralTCPCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/behavior/ILateralTCPCacheAttributes.java
index 53ec9983..89aaeddb 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/behavior/ILateralTCPCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/behavior/ILateralTCPCacheAttributes.java
@@ -38,12 +38,12 @@ public interface ILateralTCPCacheAttributes
int DEFAULT_ZOMBIE_QUEUE_MAX_SIZE = 1000;
/**
- * @return the openTimeOut
+ * @return The openTimeOut
*/
Duration getOpenTimeOut();
/**
- * @return the socketTimeOut
+ * @return The socketTimeOut
*/
Duration getSocketTimeOut();
@@ -78,28 +78,28 @@ public interface ILateralTCPCacheAttributes
/**
* The address to broadcast to if UDPDiscovery is enabled.
*
- * @return the udpDiscoveryAddr.
+ * @return The udpDiscoveryAddr.
*/
String getUdpDiscoveryAddr();
/**
* The UDP discovery network interface if UDPDiscovery is enabled.
*
- * @return the udpDiscoveryInterface.
+ * @return The udpDiscoveryInterface.
*/
String getUdpDiscoveryInterface();
/**
* The port to use if UDPDiscovery is enabled.
*
- * @return the udpDiscoveryPort.
+ * @return The udpDiscoveryPort.
*/
int getUdpDiscoveryPort();
/**
* The time-to-live for the UDP multicast packets
*
- * @return the udpTTL.
+ * @return The udpTTL.
* @since 3.1
*/
int getUdpTTL();
@@ -143,7 +143,7 @@ public interface ILateralTCPCacheAttributes
* Tests whether or not TCP laterals can try to find each other by
multicast
* communication.
*
- * @return the udpDiscoveryEnabled.
+ * @return The udpDiscoveryEnabled.
*/
boolean isUdpDiscoveryEnabled();
@@ -151,7 +151,7 @@ public interface ILateralTCPCacheAttributes
* The number of elements the zombie queue will hold. This queue is used
to store events if we
* loose our connection with the server.
*
- * @return the zombieQueueMaxSize.
+ * @return The zombieQueueMaxSize.
*/
int getZombieQueueMaxSize();
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/AbstractRemoteAuxiliaryCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/AbstractRemoteAuxiliaryCache.java
index ab8f013d..b779f90c 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/AbstractRemoteAuxiliaryCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/AbstractRemoteAuxiliaryCache.java
@@ -147,7 +147,7 @@ public abstract class AbstractRemoteAuxiliaryCache<K, V>
}
/**
- * @return the AuxiliaryCacheAttributes.
+ * @return The AuxiliaryCacheAttributes.
*/
@Override
public IRemoteCacheAttributes getAuxiliaryCacheAttributes()
@@ -213,7 +213,7 @@ public abstract class AbstractRemoteAuxiliaryCache<K, V>
}
/**
- * @return the remoteCacheListener
+ * @return The remoteCacheListener
*/
protected IRemoteCacheListener<K, V> getRemoteCacheListener()
{
@@ -221,7 +221,7 @@ public abstract class AbstractRemoteAuxiliaryCache<K, V>
}
/**
- * @return the remote
+ * @return The remote
*/
protected ICacheServiceNonLocal<K, V> getRemoteCacheService()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java
index b50930d6..f964060d 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java
@@ -103,7 +103,7 @@ public abstract class AbstractRemoteCacheNoWaitFacade<K, V>
}
/**
- * @return the AuxiliaryCacheAttributes.
+ * @return The AuxiliaryCacheAttributes.
*/
@Override
public RemoteCacheAttributes getAuxiliaryCacheAttributes()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/CommonRemoteCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/CommonRemoteCacheAttributes.java
index 72c081ed..7b5d5729 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/CommonRemoteCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/CommonRemoteCacheAttributes.java
@@ -143,7 +143,7 @@ public abstract class CommonRemoteCacheAttributes
}
/**
- * @return the rmiSocketFactoryTimeout.
+ * @return The rmiSocketFactoryTimeout.
*/
@Override
public Duration getRmiSocketFactoryTimeout()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCache.java
index 404f9295..751fc585 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCache.java
@@ -86,7 +86,7 @@ public class RemoteCache<K, V>
/**
* Gets facade
*
- * @return the facade
+ * @return The facade
*/
protected AbstractRemoteCacheNoWaitFacade<K, V> getFacade()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheAttributes.java
index 5bbf1b52..51759145 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheAttributes.java
@@ -125,7 +125,7 @@ public class RemoteCacheAttributes
}
/**
- * @return the name of the pool
+ * @return The name of the pool
*/
@Override
public String getThreadPoolName()
@@ -137,7 +137,7 @@ public class RemoteCacheAttributes
* The number of elements the zombie queue will hold. This queue is used
to store events if we
* loose our connection with the server.
*
- * @return the zombieQueueMaxSize.
+ * @return The zombieQueueMaxSize.
*/
@Override
public int getZombieQueueMaxSize()
@@ -154,7 +154,7 @@ public class RemoteCacheAttributes
* If you set this option to false, you should set your local memory size
to 0.
* <p>
* The remote cache manager uses this value to decide whether or not to
register a listener.
- * @return the receive value.
+ * @return The receive value.
*/
@Override
public boolean isReceive()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheManager.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheManager.java
index c82b48f1..75981af3 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheManager.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheManager.java
@@ -251,7 +251,7 @@ public class RemoteCacheManager
* Create new RemoteCacheNoWait instance
*
* @param cattr the cache configuration
- * @return the instance
+ * @return The instance
*/
@SuppressWarnings("unchecked")
protected <K, V> RemoteCacheNoWait<K, V> newRemoteCacheNoWait(final
IRemoteCacheAttributes cattr)
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheNoWait.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheNoWait.java
index be8d140b..683d8b26 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheNoWait.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheNoWait.java
@@ -309,7 +309,7 @@ public class RemoteCacheNoWait<K, V>
/**
* This is temporary. It allows the manager to get the lister.
*
- * @return the instance of the remote cache client used by this object
+ * @return The instance of the remote cache client used by this object
*/
protected IRemoteCacheClient<K, V> getRemoteCache()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteLocation.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteLocation.java
index 9bd45d72..005651b6 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteLocation.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteLocation.java
@@ -46,7 +46,7 @@ public record RemoteLocation(
* a RemoteLocation object
*
* @param server the input string
- * @return the remote location object
+ * @return The remote location object
*/
public static RemoteLocation parseServerAndPort(final String server)
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteUtils.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteUtils.java
index e7bb7281..0df13ae2 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteUtils.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteUtils.java
@@ -105,7 +105,7 @@ public class RemoteUtils
* <p>
*
* @param port
- * @return the registry
+ * @return The registry
*/
public static Registry createRegistry(int port)
{
@@ -162,7 +162,7 @@ public class RemoteUtils
* the remote location
* @param serviceName
* the remote service name
- * @return the URL for RMI lookup
+ * @return The URL for RMI lookup
*/
public static String getNamingURL(final RemoteLocation location, final
String serviceName)
{
@@ -178,7 +178,7 @@ public class RemoteUtils
* the remote port
* @param serviceName
* the remote service name
- * @return the URL for RMI lookup
+ * @return The URL for RMI lookup
*/
public static String getNamingURL(final String registryHost, final int
registryPort, final String serviceName)
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/behavior/IRemoteCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/behavior/IRemoteCacheAttributes.java
index d10dda23..0e9836e5 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/behavior/IRemoteCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/behavior/IRemoteCacheAttributes.java
@@ -94,7 +94,7 @@ public interface IRemoteCacheAttributes
* -1 and 0 mean no timeout, this is the default if the timeout is -1 or
0, no threadpool will
* be used.
*
- * @return the time
+ * @return The time
*/
Duration getGetTimeout();
@@ -110,7 +110,7 @@ public interface IRemoteCacheAttributes
* <p>
* The default name is "remote_cache_client"
*
- * @return the name of the pool
+ * @return The name of the pool
*/
String getThreadPoolName();
@@ -118,7 +118,7 @@ public interface IRemoteCacheAttributes
* The number of elements the zombie queue will hold. This queue is used
to store events if we
* loose our connection with the server.
*
- * @return the zombieQueueMaxSize.
+ * @return The zombieQueueMaxSize.
*/
int getZombieQueueMaxSize();
@@ -138,7 +138,7 @@ public interface IRemoteCacheAttributes
* listener id assigned from the server. As such the remote server cannot
determine if it is a
* cluster or a normal client. It will assume that it is a normal client.
*
- * @return the receive value.
+ * @return The receive value.
*/
boolean isReceive();
}
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/behavior/IRemoteCacheListener.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/behavior/IRemoteCacheListener.java
index 9c7addbc..097dac61 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/behavior/IRemoteCacheListener.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/behavior/IRemoteCacheListener.java
@@ -57,7 +57,7 @@ public interface IRemoteCacheListener<K, V>
* This is for debugging. It allows the remote cache server to log the
address of any listeners
* that register.
*
- * @return the local host address.
+ * @return The local host address.
* @throws IOException
*/
String getLocalHostAddress()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/AbstractHttpClient.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/AbstractHttpClient.java
index f326646d..7ee09c6d 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/AbstractHttpClient.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/AbstractHttpClient.java
@@ -106,7 +106,7 @@ public abstract class AbstractHttpClient
* Execute the web service call
*
* @param builder builder for the post request
- * @return the call response
+ * @return The call response
* @throws IOException on i/o error
*/
protected final HttpResponse doWebserviceCall( final RequestBuilder
builder )
@@ -121,7 +121,7 @@ public abstract class AbstractHttpClient
}
/**
- * @return the remoteHttpCacheAttributes
+ * @return The remoteHttpCacheAttributes
*/
protected RemoteHttpCacheAttributes getRemoteHttpCacheAttributes()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheAttributes.java
index 87b4ef8f..e3474c28 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheAttributes.java
@@ -64,7 +64,7 @@ public class RemoteHttpCacheAttributes
private String remoteHttpClientClassName =
DEFAULT_REMOTE_HTTP_CLIENT_CLASS_NAME;
/**
- * @return the connectionTimeout
+ * @return The connectionTimeout
*/
public Duration getConnectionTimeout()
{
@@ -72,7 +72,7 @@ public class RemoteHttpCacheAttributes
}
/**
- * @return the httpVersion
+ * @return The httpVersion
*/
public String getHttpVersion()
{
@@ -80,7 +80,7 @@ public class RemoteHttpCacheAttributes
}
/**
- * @return the maxConnectionsPerHost
+ * @return The maxConnectionsPerHost
*/
public int getMaxConnectionsPerHost()
{
@@ -88,7 +88,7 @@ public class RemoteHttpCacheAttributes
}
/**
- * @return the remoteHttpClientClassName
+ * @return The remoteHttpClientClassName
*/
public String getRemoteHttpClientClassName()
{
@@ -96,7 +96,7 @@ public class RemoteHttpCacheAttributes
}
/**
- * @return the socketTimeout
+ * @return The socketTimeout
*/
public Duration getSocketTimeout()
{
@@ -104,7 +104,7 @@ public class RemoteHttpCacheAttributes
}
/**
- * @return the url
+ * @return The url
*/
public String getUrl()
{
@@ -112,7 +112,7 @@ public class RemoteHttpCacheAttributes
}
/**
- * @return the includeCacheNameInURL
+ * @return The includeCacheNameInURL
*/
public boolean isIncludeCacheNameAsParameter()
{
@@ -120,7 +120,7 @@ public class RemoteHttpCacheAttributes
}
/**
- * @return the includeKeysAndPatternsInURL
+ * @return The includeKeysAndPatternsInURL
*/
public boolean isIncludeKeysAndPatternsAsParameter()
{
@@ -128,7 +128,7 @@ public class RemoteHttpCacheAttributes
}
/**
- * @return the includeRequestTypeasAsParameter
+ * @return The includeRequestTypeasAsParameter
*/
public boolean isIncludeRequestTypeasAsParameter()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheClient.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheClient.java
index 026645b9..f22e7911 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheClient.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheClient.java
@@ -265,7 +265,7 @@ public class RemoteHttpCacheClient<K, V>
}
/**
- * @return the remoteDispatcher
+ * @return The remoteDispatcher
*/
public IRemoteCacheDispatcher getRemoteDispatcher()
{
@@ -273,7 +273,7 @@ public class RemoteHttpCacheClient<K, V>
}
/**
- * @return the remoteHttpCacheAttributes
+ * @return The remoteHttpCacheAttributes
*/
public RemoteHttpCacheAttributes getRemoteHttpCacheAttributes()
{
@@ -325,7 +325,7 @@ public class RemoteHttpCacheClient<K, V>
}
/**
- * @return the initialized
+ * @return The initialized
*/
protected boolean isInitialized()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheFactory.java
index ba875599..95bea3a0 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheFactory.java
@@ -95,7 +95,7 @@ public class RemoteHttpCacheFactory
* RemoteHttpCacheClient through this method.
* @param cattr the cache configuration
- * @return the client instance
+ * @return The client instance
*/
protected <V, K> IRemoteHttpCacheClient<K, V>
createRemoteHttpCacheClientForAttributes(final RemoteHttpCacheAttributes cattr)
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/server/AbstractRemoteCacheService.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/server/AbstractRemoteCacheService.java
index 3c0eb1c2..aded0103 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/server/AbstractRemoteCacheService.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/server/AbstractRemoteCacheService.java
@@ -153,7 +153,7 @@ public abstract class AbstractRemoteCacheService<K, V>
}
/**
- * @return the cacheManager
+ * @return The cacheManager
*/
protected ICompositeCacheManager getCacheManager()
{
@@ -161,7 +161,7 @@ public abstract class AbstractRemoteCacheService<K, V>
}
/**
- * @return the eventLogSourceName
+ * @return The eventLogSourceName
*/
@Override
protected String getEventLogSourceName()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServer.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServer.java
index 2bbb0fdc..7ad11cf3 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServer.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServer.java
@@ -839,7 +839,7 @@ public class RemoteCacheServer<K, V>
/**
* Returns the next generated listener id [0,255].
*
- * @return the listener id of a client. This should be unique for this
server.
+ * @return The listener id of a client. This should be unique for this
server.
*/
private long nextListenerId()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServerAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServerAttributes.java
index 066886e0..c9e1f4a1 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServerAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServerAttributes.java
@@ -69,7 +69,7 @@ public class RemoteCacheServerAttributes
}
/**
- * @return the registryKeepAliveDelay
+ * @return The registryKeepAliveDelay
*/
@Override
public Duration getRegistryKeepAliveDelay()
@@ -102,7 +102,7 @@ public class RemoteCacheServerAttributes
/**
* Should we try to keep the registry alive
*
- * @return the useRegistryKeepAlive
+ * @return The useRegistryKeepAlive
*/
@Override
public boolean isUseRegistryKeepAlive()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServerFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServerFactory.java
index 67d44a96..db4780fc 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServerFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServerFactory.java
@@ -132,7 +132,7 @@ public class RemoteCacheServerFactory
* <p>
* A remote cache is either a local cache or a cluster cache.
* </p>
- * @return the remoteCacheServer.
+ * @return The remoteCacheServer.
*/
@SuppressWarnings("unchecked") // Need cast to specific RemoteCacheServer
public static <K, V> RemoteCacheServer<K, V> getRemoteCacheServer()
@@ -141,7 +141,7 @@ public class RemoteCacheServerFactory
}
/**
- * @return the serviceName
+ * @return The serviceName
*/
protected static String getServiceName()
{
@@ -236,7 +236,7 @@ public class RemoteCacheServerFactory
*
* @param config the configuration properties
* @param port the local port
- * @return the admin object instance
+ * @return The admin object instance
* @throws Exception if lookup fails
*/
private static ICacheServiceAdmin lookupCacheServiceAdmin(final Properties
config, final int port) throws Exception
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/TimeoutConfigurableRMISocketFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/TimeoutConfigurableRMISocketFactory.java
index d911da25..e468ddc2 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/TimeoutConfigurableRMISocketFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/TimeoutConfigurableRMISocketFactory.java
@@ -79,7 +79,7 @@ public class TimeoutConfigurableRMISocketFactory
}
/**
- * @return the openTimeout
+ * @return The openTimeout
*/
public Duration getOpenTimeout()
{
@@ -87,7 +87,7 @@ public class TimeoutConfigurableRMISocketFactory
}
/**
- * @return the readTimeout
+ * @return The readTimeout
*/
public Duration getReadTimeout()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/behavior/IRemoteCacheServerAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/behavior/IRemoteCacheServerAttributes.java
index cae5c3e5..f997780c 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/behavior/IRemoteCacheServerAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/behavior/IRemoteCacheServerAttributes.java
@@ -38,7 +38,7 @@ public interface IRemoteCacheServerAttributes
String getConfigFileName();
/**
- * @return the registryKeepAliveDelay
+ * @return The registryKeepAliveDelay
*/
Duration getRegistryKeepAliveDelay();
@@ -64,7 +64,7 @@ public interface IRemoteCacheServerAttributes
/**
* Should we try to keep the registry alive
*
- * @return the useRegistryKeepAlive
+ * @return The useRegistryKeepAlive
*/
boolean isUseRegistryKeepAlive();
}
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/AbstractCacheEventQueue.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/AbstractCacheEventQueue.java
index 3da70776..4c459a5f 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/AbstractCacheEventQueue.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/AbstractCacheEventQueue.java
@@ -248,7 +248,7 @@ public abstract class AbstractCacheEventQueue<K, V>
}
/**
- * @return the cacheName
+ * @return The cacheName
*/
protected String getCacheName()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/PooledCacheEventQueue.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/PooledCacheEventQueue.java
index 0b5716d3..1f8178e8 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/PooledCacheEventQueue.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/PooledCacheEventQueue.java
@@ -116,7 +116,7 @@ public class PooledCacheEventQueue<K, V>
}
/**
- * @return the queue type
+ * @return The queue type
*/
@Override
public QueueType getQueueType()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheEventQueue.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheEventQueue.java
index aa56e868..bca26632 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheEventQueue.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheEventQueue.java
@@ -103,7 +103,7 @@ public interface ICacheEventQueue<K, V>
/**
* Return the type of event queue we are using, either single or pooled.
*
- * @return the queue type: single or pooled
+ * @return The queue type: single or pooled
*/
QueueType getQueueType();
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheService.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheService.java
index de433c5e..e9994a45 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheService.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheService.java
@@ -45,7 +45,7 @@ public interface ICacheService<K, V>
*
* @param cacheName
* @param key
- * @return the ICacheElement<K, V> or null if not found
+ * @return The ICacheElement<K, V> or null if not found
* @throws IOException
*/
ICacheElement<K, V> get( String cacheName, K key )
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICompositeCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICompositeCacheAttributes.java
index 80114dde..d2a54e3a 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICompositeCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICompositeCacheAttributes.java
@@ -48,7 +48,7 @@ public interface ICompositeCacheAttributes
String cacheName();
/**
- * @return the DiskUsagePattern.
+ * @return The DiskUsagePattern.
*/
DiskUsagePatternEnum DiskUsagePattern();
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICompositeCacheManager.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICompositeCacheManager.java
index e13b5113..b6f3dfad 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICompositeCacheManager.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICompositeCacheManager.java
@@ -50,7 +50,7 @@ public interface ICompositeCacheManager extends
IShutdownObservable
/**
* This is exposed so other manager can get access to the props.
*
- * @return the configurationProperties
+ * @return The configurationProperties
*/
Properties getConfigurationProperties();
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/IElementSerializer.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/IElementSerializer.java
index 9919081f..7af3efa6 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/IElementSerializer.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/IElementSerializer.java
@@ -203,7 +203,7 @@ public interface IElementSerializer
* @param obj the object to serialize
* @param oc the output channel
* @param writeTimeoutMs the write timeout im milliseconds
- * @return the number of bytes written
+ * @return The number of bytes written
* @throws IOException if serialization or writing fails
* @since 3.1
*/
@@ -240,7 +240,7 @@ public interface IElementSerializer
* @param <T> The type of the object
* @param obj the object to serialize
* @param os the output stream
- * @return the number of bytes written
+ * @return The number of bytes written
* @throws IOException if serialization or writing fails
* @since 3.1
*/
@@ -264,7 +264,7 @@ public interface IElementSerializer
* @param <T> The type of the object
* @param obj the object to serialize
* @param oc the output channel
- * @return the number of bytes written
+ * @return The number of bytes written
* @throws IOException if serialization or writing fails
* @since 3.1
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/IProvideScheduler.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/IProvideScheduler.java
index 50e6cf2e..ebaf1018 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/IProvideScheduler.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/IProvideScheduler.java
@@ -28,7 +28,7 @@ public interface IProvideScheduler
{
/**
* Gets an instance of a central ScheduledExecutorService
- * @return the central scheduler
+ * @return The central scheduler
*/
ScheduledExecutorService getScheduledExecutorService();
}
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCache.java
index 7a4df5d5..27060aa1 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCache.java
@@ -710,7 +710,7 @@ public class CompositeCache<K, V>
/**
* Access to the memory cache for instrumentation.
*
- * @return the MemoryCache implementation
+ * @return The MemoryCache implementation
*/
public IMemoryCache<K, V> getMemoryCache()
{
@@ -800,7 +800,7 @@ public class CompositeCache<K, V>
*
* @param keys
* @param localOnly
- * @return the elements found in the auxiliary caches
+ * @return The elements found in the auxiliary caches
* @throws IOException
*/
private Map<K, ICacheElement<K, V>> getMultipleFromAuxiliaryCaches(final
Set<K> keys, final boolean localOnly)
@@ -850,7 +850,7 @@ public class CompositeCache<K, V>
* Gets items for the keys in the set. Returns a map: key -> result.
*
* @param keys
- * @return the elements found in the memory cache
+ * @return The elements found in the memory cache
* @throws IOException
*/
private Map<K, ICacheElement<K, V>> getMultipleFromMemory(final Set<K>
keys)
@@ -925,7 +925,7 @@ public class CompositeCache<K, V>
}
/**
- * @return the updateCount.
+ * @return The updateCount.
*/
public long getUpdateCount()
{
@@ -1158,7 +1158,7 @@ public class CompositeCache<K, V>
*
* @param keys
* @param foundElements
- * @return the original set of cache keys, minus any cache keys present in
the map keys of the
+ * @return The original set of cache keys, minus any cache keys present in
the map keys of the
* foundElements map
*/
private Set<K> pruneKeysFound(final Set<K> keys, final Map<K,
ICacheElement<K, V>> foundElements)
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCacheManager.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCacheManager.java
index e7706fed..81342d98 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCacheManager.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCacheManager.java
@@ -475,7 +475,7 @@ public class CompositeCacheManager
*
* @param auxName the auxiliary name
* @param cacheName the region name
- * @return the cache instance
+ * @return The cache instance
*/
@Override
@SuppressWarnings("unchecked") // because of common map for all auxiliary
caches
@@ -580,7 +580,7 @@ public class CompositeCacheManager
/**
* This is exposed so other manager can get access to the props.
*
- * @return the configurationProperties
+ * @return The configurationProperties
*/
@Override
public Properties getConfigurationProperties()
@@ -611,7 +611,7 @@ public class CompositeCacheManager
/**
* Gets the element event queue
*
- * @return the elementEventQueue
+ * @return The elementEventQueue
*/
public IElementEventQueue getElementEventQueue()
{
@@ -621,7 +621,7 @@ public class CompositeCacheManager
/**
* Gets the scheduler service
*
- * @return the scheduledExecutor
+ * @return The scheduledExecutor
*/
@Override
public ScheduledExecutorService getScheduledExecutorService()
@@ -691,7 +691,7 @@ public class CompositeCacheManager
}
/**
- * @return the isConfigured
+ * @return The isConfigured
*/
public boolean isConfigured()
{
@@ -699,7 +699,7 @@ public class CompositeCacheManager
}
/**
- * @return the isInitialized
+ * @return The isInitialized
*/
public boolean isInitialized()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/event/behavior/IElementEvent.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/event/behavior/IElementEvent.java
index 66583c6f..24f3e874 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/event/behavior/IElementEvent.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/event/behavior/IElementEvent.java
@@ -36,7 +36,7 @@ public interface IElementEvent<T>
ElementEventType elementEventType();
/**
- * @return the source of the event.
+ * @return The source of the event.
*/
T source();
}
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/group/GroupAttrName.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/group/GroupAttrName.java
index 7b695634..6ecad7d0 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/group/GroupAttrName.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/group/GroupAttrName.java
@@ -45,7 +45,7 @@ public record GroupAttrName<T>(GroupId groupId, T attrName)
}
/**
- * @return the cached value.
+ * @return The cached value.
*/
@Override
public String toString()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/group/GroupId.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/group/GroupId.java
index fc4dbf03..5084abcd 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/group/GroupId.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/group/GroupId.java
@@ -52,7 +52,7 @@ public record GroupId(String cacheName, String groupName)
/**
* Convert to string
*
- * @return the string representation of this ID.
+ * @return The string representation of this ID.
*/
@Override
public String toString()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/logging/behavior/ICacheEvent.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/logging/behavior/ICacheEvent.java
index b958f6e4..fff4c583 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/logging/behavior/ICacheEvent.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/logging/behavior/ICacheEvent.java
@@ -28,27 +28,27 @@ public interface ICacheEvent<K>
extends Serializable
{
/**
- * @return the eventName
+ * @return The eventName
*/
CacheEventType eventType();
/**
- * @return the key
+ * @return The key
*/
K key();
/**
- * @return the optionalDetails
+ * @return The optionalDetails
*/
String optionalDetails();
/**
- * @return the region
+ * @return The region
*/
String region();
/**
- * @return the source
+ * @return The source
*/
String source();
}
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractDoubleLinkedListMemoryCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractDoubleLinkedListMemoryCache.java
index dba36124..3100eaa2 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractDoubleLinkedListMemoryCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractDoubleLinkedListMemoryCache.java
@@ -153,7 +153,7 @@ public abstract class
AbstractDoubleLinkedListMemoryCache<K, V> extends Abstract
* <p>
*
* @param numberToFree
- * @return the number that were removed. if you ask to free 5, but there
are only 3, you will
+ * @return The number that were removed. if you ask to free 5, but there
are only 3, you will
* get 3.
*/
@Override
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/behavior/IMemoryCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/behavior/IMemoryCache.java
index 0ff3df3d..ad37f575 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/behavior/IMemoryCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/behavior/IMemoryCache.java
@@ -46,7 +46,7 @@ public interface IMemoryCache<K, V>
* spooled to disk if a disk auxiliary is available.
*
* @param numberToFree
- * @return the number that were removed. if you ask to free 5, but there
are
+ * @return The number that were removed. if you ask to free 5, but there
are
* only 3, you will get 3.
* @throws IOException
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/util/MemoryElementDescriptor.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/util/MemoryElementDescriptor.java
index 3092863c..ad0ae973 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/util/MemoryElementDescriptor.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/util/MemoryElementDescriptor.java
@@ -44,7 +44,7 @@ public class MemoryElementDescriptor<K, V>
/**
* Gets the cache element
*
- * @return the ce
+ * @return The ce
*/
public ICacheElement<K, V> getCacheElement()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/util/SoftReferenceElementDescriptor.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/util/SoftReferenceElementDescriptor.java
index 910cf9b6..08461f9f 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/util/SoftReferenceElementDescriptor.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/util/SoftReferenceElementDescriptor.java
@@ -47,7 +47,7 @@ public class SoftReferenceElementDescriptor<K, V>
}
/**
- * @return the ce
+ * @return The ce
*/
@Override
public ICacheElement<K, V> getCacheElement()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/stats/Stats.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/stats/Stats.java
index d85ac551..f9408c81 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/stats/Stats.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/stats/Stats.java
@@ -116,7 +116,7 @@ public class Stats
}
/**
- * @return the stats in a readable string
+ * @return The stats in a readable string
*/
@Override
public String toString()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/stats/behavior/IStatElement.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/stats/behavior/IStatElement.java
index 2abcbf19..5796a047 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/stats/behavior/IStatElement.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/stats/behavior/IStatElement.java
@@ -36,7 +36,7 @@ public interface IStatElement<V> extends Serializable
/**
* Gets the name of the stat element, for example, HitCount
*
- * @return the stat element name
+ * @return The stat element name
*/
String name();
}
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/log/Log.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/log/Log.java
index 024e7cde..d7a74c44 100644
--- a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/log/Log.java
+++ b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/log/Log.java
@@ -170,7 +170,7 @@ public interface Log
/**
* Gets the logger name.
*
- * @return the logger name.
+ * @return The logger name.
*/
String getName();
@@ -349,7 +349,7 @@ public interface Log
/**
* Returns the root logger.
*
- * @return the root logger, named {@link ROOT_LOGGER_NAME}.
+ * @return The root logger, named {@link ROOT_LOGGER_NAME}.
*/
static Log getRootLogger()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/log/MessageFormatter.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/log/MessageFormatter.java
index d1c58c58..ac81168f 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/log/MessageFormatter.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/log/MessageFormatter.java
@@ -91,7 +91,7 @@ public class MessageFormatter
/**
* Returns the formatted message.
*
- * @return the formatted message.
+ * @return The formatted message.
*/
public String getFormattedMessage()
{
@@ -105,7 +105,7 @@ public class MessageFormatter
/**
* Return the throwable passed to the Message.
*
- * @return the Throwable.
+ * @return The Throwable.
*/
public Throwable getThrowable()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/log/SystemLogAdapter.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/log/SystemLogAdapter.java
index 9de241e5..ab0f03b8 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/log/SystemLogAdapter.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/log/SystemLogAdapter.java
@@ -227,7 +227,7 @@ public class SystemLogAdapter implements Log
/**
* Gets the logger name.
*
- * @return the logger name.
+ * @return The logger name.
*/
@Override
public String getName()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/config/OptionConverter.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/config/OptionConverter.java
index 315f48f2..43c41468 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/config/OptionConverter.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/config/OptionConverter.java
@@ -247,7 +247,7 @@ public class OptionConverter
* hidden.
* @param key The key to search for.
* @param def The default value to return.
- * @return the string value of the system property, or the default value
if there is no property
+ * @return The string value of the system property, or the default value
if there is no property
* with that key.
* @since 1.1
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/DiscoveredService.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/DiscoveredService.java
index 69d80e29..f92c9ccd 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/DiscoveredService.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/DiscoveredService.java
@@ -95,7 +95,7 @@ public class DiscoveredService
}
/**
- * @return the cacheNames
+ * @return The cacheNames
*/
public ArrayList<String> getCacheNames()
{
@@ -103,7 +103,7 @@ public class DiscoveredService
}
/**
- * @return the lastHearFromTime.
+ * @return The lastHearFromTime.
*/
public Instant getLastHearFromTime()
{
@@ -111,7 +111,7 @@ public class DiscoveredService
}
/**
- * @return the serviceAddress.
+ * @return The serviceAddress.
*/
public String getServiceAddress()
{
@@ -119,7 +119,7 @@ public class DiscoveredService
}
/**
- * @return the servicePort.
+ * @return The servicePort.
*/
public int getServicePort()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryMessage.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryMessage.java
index 38679b04..7c4c387d 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryMessage.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryMessage.java
@@ -66,7 +66,7 @@ public class UDPDiscoveryMessage
private ArrayList<String> cacheNames = new ArrayList<>();
/**
- * @return the cacheNames.
+ * @return The cacheNames.
*/
public ArrayList<String> getCacheNames()
{
@@ -74,7 +74,7 @@ public class UDPDiscoveryMessage
}
/**
- * @return the host.
+ * @return The host.
*/
public String getHost()
{
@@ -82,7 +82,7 @@ public class UDPDiscoveryMessage
}
/**
- * @return the messageType.
+ * @return The messageType.
*/
public BroadcastType getMessageType()
{
@@ -90,7 +90,7 @@ public class UDPDiscoveryMessage
}
/**
- * @return the port.
+ * @return The port.
*/
public int getPort()
{
@@ -98,7 +98,7 @@ public class UDPDiscoveryMessage
}
/**
- * @return the requesterId.
+ * @return The requesterId.
*/
public long getRequesterId()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryReceiver.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryReceiver.java
index c8f366e8..e5b415e9 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryReceiver.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryReceiver.java
@@ -188,7 +188,7 @@ public class UDPDiscoveryReceiver
}
/**
- * @return the cnt.
+ * @return The cnt.
*/
protected int getCnt()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryService.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryService.java
index f5ccb0c5..96714e86 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryService.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryService.java
@@ -286,7 +286,7 @@ public class UDPDiscoveryService
}
/**
- * @return the discoveredServices.
+ * @return The discoveredServices.
*/
public Set<DiscoveredService> getDiscoveredServices()
{
@@ -296,7 +296,7 @@ public class UDPDiscoveryService
/**
* Return the serializer implementation
*
- * @return the serializer
+ * @return The serializer
* @since 3.1
*/
protected IElementSerializer getSerializer()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/struct/LRUElementDescriptor.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/struct/LRUElementDescriptor.java
index 51609e37..27a4eb2c 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/struct/LRUElementDescriptor.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/struct/LRUElementDescriptor.java
@@ -43,7 +43,7 @@ public class LRUElementDescriptor<K, V>
}
/**
- * @return the key.
+ * @return The key.
*/
public K getKey()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/timing/ElapsedTimer.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/timing/ElapsedTimer.java
index 5832c8eb..fa1bdf20 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/timing/ElapsedTimer.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/timing/ElapsedTimer.java
@@ -39,7 +39,7 @@ public class ElapsedTimer
* Gets the time elapsed between the start time and now. The start time is
reset to now.
* Subsequent calls will get the time between then and now.
*
- * @return the elapsed time
+ * @return The elapsed time
*/
public long getElapsedTime()
{
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/MockCacheEventLogger.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/MockCacheEventLogger.java
index 75709f37..2b11a544 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/MockCacheEventLogger.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/MockCacheEventLogger.java
@@ -100,7 +100,7 @@ public class MockCacheEventLogger
}
/**
- * @return the testProperty
+ * @return The testProperty
*/
public String getTestProperty()
{
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/server/MockRMISocketFactory.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/server/MockRMISocketFactory.java
index b9bb3152..d34f3e6c 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/server/MockRMISocketFactory.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/server/MockRMISocketFactory.java
@@ -71,7 +71,7 @@ public class MockRMISocketFactory
}
/**
- * @return the testStringProperty
+ * @return The testStringProperty
*/
public String getTestStringProperty()
{
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/MockCompositeCacheManager.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/MockCompositeCacheManager.java
index 8f59ad2c..9c45e48b 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/MockCompositeCacheManager.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/MockCompositeCacheManager.java
@@ -54,7 +54,7 @@ public class MockCompositeCacheManager
}
/**
- * @return the cache.
+ * @return The cache.
*/
public CompositeCache<?, ?> getCache()
{
@@ -83,7 +83,7 @@ public class MockCompositeCacheManager
/**
* This is exposed so other manager can get access to the props.
*
- * @return the configurationProperties
+ * @return The configurationProperties
*/
@Override
public Properties getConfigurationProperties()
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/event/ElementEventHandlerMockImpl.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/event/ElementEventHandlerMockImpl.java
index 8a958ad2..5bf7560e 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/event/ElementEventHandlerMockImpl.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/event/ElementEventHandlerMockImpl.java
@@ -51,7 +51,7 @@ public class ElementEventHandlerMockImpl
private int exceededIdleTimeBackgroundCount;
/**
- * @return the callCount.
+ * @return The callCount.
*/
public int getCallCount()
{
@@ -59,7 +59,7 @@ public class ElementEventHandlerMockImpl
}
/**
- * @return the exceededIdleTimeBackground.
+ * @return The exceededIdleTimeBackground.
*/
public int getExceededIdleTimeBackgroundCount()
{
@@ -67,7 +67,7 @@ public class ElementEventHandlerMockImpl
}
/**
- * @return the exceededMaxLifeBackground.
+ * @return The exceededMaxLifeBackground.
*/
public int getExceededMaxLifeBackgroundCount()
{
@@ -75,7 +75,7 @@ public class ElementEventHandlerMockImpl
}
/**
- * @return the spoolCount.
+ * @return The spoolCount.
*/
public int getSpoolCount()
{
@@ -83,7 +83,7 @@ public class ElementEventHandlerMockImpl
}
/**
- * @return the spoolNoDiskCount.
+ * @return The spoolNoDiskCount.
*/
public int getSpoolNoDiskCount()
{
@@ -91,7 +91,7 @@ public class ElementEventHandlerMockImpl
}
/**
- * @return the spoolNotAllowedCount.
+ * @return The spoolNotAllowedCount.
*/
public int getSpoolNotAllowedCount()
{
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/event/SimpleEventHandlingUnitTest.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/event/SimpleEventHandlingUnitTest.java
index 46556fa5..414a357d 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/event/SimpleEventHandlingUnitTest.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/event/SimpleEventHandlingUnitTest.java
@@ -62,7 +62,7 @@ class SimpleEventHandlingUnitTest
private int exceededIdletimeCount;
/**
- * @return the exceededIdletimeCount
+ * @return The exceededIdletimeCount
*/
protected int getExceededIdletimeCount()
{
@@ -70,7 +70,7 @@ class SimpleEventHandlingUnitTest
}
/**
- * @return the exceededMaxlifeCount
+ * @return The exceededMaxlifeCount
*/
protected int getExceededMaxlifeCount()
{
@@ -78,7 +78,7 @@ class SimpleEventHandlingUnitTest
}
/**
- * @return the spoolCount.
+ * @return The spoolCount.
*/
protected int getSpoolCount()
{
@@ -86,7 +86,7 @@ class SimpleEventHandlingUnitTest
}
/**
- * @return the spoolNoDiskCount.
+ * @return The spoolNoDiskCount.
*/
protected int getSpoolNoDiskCount()
{
@@ -94,7 +94,7 @@ class SimpleEventHandlingUnitTest
}
/**
- * @return the spoolNotAllowedCount.
+ * @return The spoolNotAllowedCount.
*/
protected int getSpoolNotAllowedCount()
{
diff --git
a/commons-jcs4-sandbox/commons-jcs4-filecache/src/main/java/org/apache/commons/jcs/auxiliary/disk/file/FileDiskCache.java
b/commons-jcs4-sandbox/commons-jcs4-filecache/src/main/java/org/apache/commons/jcs/auxiliary/disk/file/FileDiskCache.java
index 1186f21a..5507bec8 100644
---
a/commons-jcs4-sandbox/commons-jcs4-filecache/src/main/java/org/apache/commons/jcs/auxiliary/disk/file/FileDiskCache.java
+++
b/commons-jcs4-sandbox/commons-jcs4-filecache/src/main/java/org/apache/commons/jcs/auxiliary/disk/file/FileDiskCache.java
@@ -133,7 +133,7 @@ public class FileDiskCache<K, V>
* Protected for testing.
*
* @param key
- * @return the file for the key
+ * @return The file for the key
*/
protected <KK> File file( final KK key )
{
@@ -580,7 +580,7 @@ public class FileDiskCache<K, V>
}
/**
- * @return the directory
+ * @return The directory
*/
protected File getDirectory()
{
diff --git
a/commons-jcs4-sandbox/commons-jcs4-filecache/src/main/java/org/apache/commons/jcs/auxiliary/disk/file/FileDiskCacheAttributes.java
b/commons-jcs4-sandbox/commons-jcs4-filecache/src/main/java/org/apache/commons/jcs/auxiliary/disk/file/FileDiskCacheAttributes.java
index 818f96a3..7d0583ee 100644
---
a/commons-jcs4-sandbox/commons-jcs4-filecache/src/main/java/org/apache/commons/jcs/auxiliary/disk/file/FileDiskCacheAttributes.java
+++
b/commons-jcs4-sandbox/commons-jcs4-filecache/src/main/java/org/apache/commons/jcs/auxiliary/disk/file/FileDiskCacheAttributes.java
@@ -64,7 +64,7 @@ public class FileDiskCacheAttributes
}
/**
- * @return the maxNumberOfFiles
+ * @return The maxNumberOfFiles
*/
public int getMaxNumberOfFiles()
{
@@ -80,7 +80,7 @@ public class FileDiskCacheAttributes
}
/**
- * @return the maxRetriesOnDelete
+ * @return The maxRetriesOnDelete
*/
public int getMaxRetriesOnDelete()
{
@@ -96,7 +96,7 @@ public class FileDiskCacheAttributes
}
/**
- * @return the touchOnGet
+ * @return The touchOnGet
*/
public boolean isTouchOnGet()
{
@@ -112,7 +112,7 @@ public class FileDiskCacheAttributes
}
/**
- * @return the maxRetriesOnTouch
+ * @return The maxRetriesOnTouch
*/
public int getMaxRetriesOnTouch()
{
diff --git
a/commons-jcs4-sandbox/commons-jcs4-partitioned/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java
b/commons-jcs4-sandbox/commons-jcs4-partitioned/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java
index 90255b4a..f81957e3 100644
---
a/commons-jcs4-sandbox/commons-jcs4-partitioned/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java
+++
b/commons-jcs4-sandbox/commons-jcs4-partitioned/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java
@@ -648,7 +648,7 @@ public class PartitionedCacheAccess<K, V>
* We determine the partition by taking the mod of the number of
partitions.
*
* @param key key
- * @return the partition number.
+ * @return The partition number.
*/
protected int getPartitionNumberForKey( K key )
{
@@ -782,7 +782,7 @@ public class PartitionedCacheAccess<K, V>
*
* @param propertyName name
* @param required is it required?
- * @return the property value if one is found
+ * @return The property value if one is found
* @throws ConfigurationException thrown if it is required and not found.
*/
protected String getPropertyForName( String propertyName, boolean required
)
@@ -821,7 +821,7 @@ public class PartitionedCacheAccess<K, V>
}
/**
- * @return the numberOfPartitions.
+ * @return The numberOfPartitions.
*/
protected int getNumberOfPartitions()
{
@@ -837,7 +837,7 @@ public class PartitionedCacheAccess<K, V>
}
/**
- * @return the partitionRegionNamePrefix.
+ * @return The partitionRegionNamePrefix.
*/
protected String getPartitionRegionNamePrefix()
{
@@ -853,7 +853,7 @@ public class PartitionedCacheAccess<K, V>
}
/**
- * @return the partitions.
+ * @return The partitions.
*/
protected ICacheAccess<K, V>[] getPartitions()
{
diff --git
a/commons-jcs4-sandbox/commons-jcs4-partitioned/src/main/java/org/apache/commons/jcs/utils/props/AbstractPropertyContainer.java
b/commons-jcs4-sandbox/commons-jcs4-partitioned/src/main/java/org/apache/commons/jcs/utils/props/AbstractPropertyContainer.java
index fb73c35c..fd43d5a1 100644
---
a/commons-jcs4-sandbox/commons-jcs4-partitioned/src/main/java/org/apache/commons/jcs/utils/props/AbstractPropertyContainer.java
+++
b/commons-jcs4-sandbox/commons-jcs4-partitioned/src/main/java/org/apache/commons/jcs/utils/props/AbstractPropertyContainer.java
@@ -125,7 +125,7 @@ public abstract class AbstractPropertyContainer
throws ConfigurationException;
/**
- * @return the properties.
+ * @return The properties.
*/
public synchronized Properties getProperties()
{
@@ -141,7 +141,7 @@ public abstract class AbstractPropertyContainer
}
/**
- * @return the propertiesHeading.
+ * @return The propertiesHeading.
*/
public synchronized String getPropertiesHeading()
{
@@ -157,7 +157,7 @@ public abstract class AbstractPropertyContainer
}
/**
- * @return the propertiesFactory.
+ * @return The propertiesFactory.
*/
public PropertiesFactory getPropertiesFactory()
{
@@ -173,7 +173,7 @@ public abstract class AbstractPropertyContainer
}
/**
- * @return the propertiesGroup.
+ * @return The propertiesGroup.
*/
public String getPropertiesGroup()
{
diff --git
a/commons-jcs4-sandbox/commons-jcs4-yajcache/src/main/java/org/apache/commons/jcs/yajcache/file/CacheFileDAO.java
b/commons-jcs4-sandbox/commons-jcs4-yajcache/src/main/java/org/apache/commons/jcs/yajcache/file/CacheFileDAO.java
index c5fffe05..3250e445 100644
---
a/commons-jcs4-sandbox/commons-jcs4-yajcache/src/main/java/org/apache/commons/jcs/yajcache/file/CacheFileDAO.java
+++
b/commons-jcs4-sandbox/commons-jcs4-yajcache/src/main/java/org/apache/commons/jcs/yajcache/file/CacheFileDAO.java
@@ -82,7 +82,7 @@ public enum CacheFileDAO {
/**
* Reads the byte array of a specified cache item from the file system.
*
- * @return the byte array of a specified cache item from the file system;
+ * @return The byte array of a specified cache item from the file system;
* or null if it doesn't exist;
* or CacheFileContent.CORRUPTED if file is corrupted.
*/
diff --git
a/src/experimental/org/apache/commons/jcs/auxiliary/lateral/http/broadcast/LateralCacheUnicaster.java
b/src/experimental/org/apache/commons/jcs/auxiliary/lateral/http/broadcast/LateralCacheUnicaster.java
index 110e85a1..298448c2 100644
---
a/src/experimental/org/apache/commons/jcs/auxiliary/lateral/http/broadcast/LateralCacheUnicaster.java
+++
b/src/experimental/org/apache/commons/jcs/auxiliary/lateral/http/broadcast/LateralCacheUnicaster.java
@@ -135,7 +135,7 @@ public class LateralCacheUnicaster
/**
* Sends the ICacheItem to the current URLConnection.
*
- * @return the response from the current URLConnection.
+ * @return The response from the current URLConnection.
*/
private String sendCacheItem()
{
diff --git
a/src/experimental/org/apache/commons/jcs/engine/memory/arc/ARCMemoryCache.java
b/src/experimental/org/apache/commons/jcs/engine/memory/arc/ARCMemoryCache.java
index e02107fe..bdfc0f90 100644
---
a/src/experimental/org/apache/commons/jcs/engine/memory/arc/ARCMemoryCache.java
+++
b/src/experimental/org/apache/commons/jcs/engine/memory/arc/ARCMemoryCache.java
@@ -766,7 +766,7 @@ public class ARCMemoryCache
/**
* At the start this will be 1/2 the max.
*
- * @return the target_T1.
+ * @return The target_T1.
*/
protected int getTarget_T1()
{
