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 e1426980 Javadoc
e1426980 is described below
commit e14269809e50b4b30bd665fc0571d93e041b8054
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Aug 2 17:11:45 2026 -0400
Javadoc
---
.../apache/commons/jcs4/auxiliary/AuxiliaryCache.java | 2 +-
.../commons/jcs4/auxiliary/AuxiliaryCacheFactory.java | 2 +-
.../commons/jcs4/auxiliary/disk/jdbc/JDBCConnection.java | 2 +-
.../commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCache.java | 4 ++--
.../jcs4/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java | 4 ++--
.../auxiliary/disk/jdbc/dsfactory/DataSourceFactory.java | 2 +-
.../disk/jdbc/dsfactory/JndiDataSourceFactory.java | 2 +-
.../disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java | 6 +++---
.../auxiliary/disk/jdbc/hsql/HSQLDiskCacheFactory.java | 2 +-
.../jcs4/auxiliary/disk/jdbc/mysql/MySQLDiskCache.java | 2 +-
.../auxiliary/disk/jdbc/mysql/MySQLDiskCacheFactory.java | 2 +-
.../jcs4/auxiliary/remote/RemoteCacheManager.java | 2 +-
.../remote/server/RemoteCacheServerFactory.java | 2 +-
.../commons/jcs4/engine/behavior/IElementSerializer.java | 16 ++++++++--------
.../jcs4/engine/control/CompositeCacheManager.java | 4 ++--
.../commons/jcs4/auxiliary/disk/jdbc/HsqlSetupUtil.java | 2 +-
16 files changed, 28 insertions(+), 28 deletions(-)
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 43b57577..a8887373 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
@@ -48,7 +48,7 @@ public interface AuxiliaryCache<K, V>
* TODO This should probably be done in chunks with a range passed in. This
* will be a problem if someone puts a 1,000,000 or so items in a
* region.
- * @throws IOException if access to the auxiliary cache fails
+ * @throws IOException Thrown if access to the auxiliary cache fails
*/
Set<K> getKeySet() throws IOException;
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AuxiliaryCacheFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AuxiliaryCacheFactory.java
index 7df8f93e..055ff581 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AuxiliaryCacheFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AuxiliaryCacheFactory.java
@@ -40,7 +40,7 @@ public interface AuxiliaryCacheFactory
* @param elementSerializer The serializer for cache elements
* @param keyMatcher The key matcher for getMatching() calls
* @return AuxiliaryCache
- * @throws Exception if cache instance could not be created
+ * @throws Exception Thrown if cache instance could not be created
*/
<K, V> AuxiliaryCache<K, V> createCache(
AuxiliaryCacheAttributes attr, ICompositeCacheManager cacheMgr,
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCConnection.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCConnection.java
index a79aa73d..0503de5a 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCConnection.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCConnection.java
@@ -41,7 +41,7 @@ public class JDBCConnection implements AutoCloseable
/**
* Constructs a new instance.
* @param con Connection object
- * @throws SQLException if a database error occurs
+ * @throws SQLException Thrown if a database error occurs
*/
public JDBCConnection(final Connection con) throws SQLException
{
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 7e787384..0823a5d3 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
@@ -159,7 +159,7 @@ public class JDBCDiskCache<K, V>
* Get a connection from the data source and prepare it for use
*
* @return A database connection
- * @throws SQLException if getting the connection goes wrong
+ * @throws SQLException Thrown if getting the connection goes wrong
*/
protected JDBCConnection getConnection() throws SQLException
{
@@ -265,7 +265,7 @@ public class JDBCDiskCache<K, V>
/**
* Public so managers can access it.
* @return The dsFactory
- * @throws SQLException if getting a data source fails
+ * @throws SQLException Thrown if getting a data source fails
*/
public DataSource getDataSource() throws SQLException
{
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 fa57e8d7..ea2f9a3e 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
@@ -82,7 +82,7 @@ public class JDBCDiskCacheFactory
* @param elementSerializer The serializer for cache elements
* @param keyMatcher The key matcher for getMatching() calls
* @return JDBCDiskCache the cache instance
- * @throws SQLException if the cache instance could not be created
+ * @throws SQLException Thrown if the cache instance could not be created
*/
@Override
public <K, V> JDBCDiskCache<K, V> createCache( final
AuxiliaryCacheAttributes rawAttr,
@@ -163,7 +163,7 @@ public class JDBCDiskCacheFactory
* @param cattr The cache configuration
* @param configProps The configuration properties object
* @return A DataSourceFactory
- * @throws SQLException if a database access error occurs
+ * @throws SQLException Thrown if a database access error occurs
*/
protected DataSourceFactory getDataSourceFactory( final
JDBCDiskCacheAttributes cattr,
final Properties
configProps ) throws SQLException
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 cc1390ba..d38357d3 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
@@ -59,7 +59,7 @@ public interface DataSourceFactory
/**
* @return The {@code DataSource} configured by the factory.
- * @throws SQLException if the source can't be returned
+ * @throws SQLException Thrown if the source can't be returned
*/
DataSource getDataSource() throws SQLException;
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 e519550b..25f13c44 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
@@ -138,7 +138,7 @@ public class JndiDataSourceFactory implements
DataSourceFactory
* Initializes JNDI.
*
* @param config where to read the settings from
- * @throws SQLException if a property set fails
+ * @throws SQLException Thrown if a property set fails
*/
private void initJNDI(final JDBCDiskCacheAttributes config) throws
SQLException
{
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 97ac35a9..13f50df1 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
@@ -44,7 +44,7 @@ public class SharedPoolDataSourceFactory implements
DataSourceFactory
* Initializes the ConnectionPoolDataSource.
*
* @param config where to read the settings from
- * @throws SQLException if a property set fails
+ * @throws SQLException Thrown if a property set fails
* @return A configured {@code ConnectionPoolDataSource}
*/
private static ConnectionPoolDataSource initCPDS(final
JDBCDiskCacheAttributes config)
@@ -75,7 +75,7 @@ public class SharedPoolDataSourceFactory implements
DataSourceFactory
*
* @param dataSource The dataSource to initialize, not null.
* @param config where to read the settings from, not null.
- * @throws SQLException if a property set fails.
+ * @throws SQLException Thrown if a property set fails.
*/
private static void initJdbc2Pool(final InstanceKeyDataSource dataSource,
final JDBCDiskCacheAttributes config)
throws SQLException
@@ -94,7 +94,7 @@ public class SharedPoolDataSourceFactory implements
DataSourceFactory
/**
* Closes the pool associated with this factory and releases it.
- * @throws SQLException if the pool cannot be closed properly
+ * @throws SQLException Thrown if the pool cannot be closed properly
*/
@Override
public void close() throws SQLException
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/hsql/HSQLDiskCacheFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/hsql/HSQLDiskCacheFactory.java
index 8efbf636..82f10116 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/hsql/HSQLDiskCacheFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/hsql/HSQLDiskCacheFactory.java
@@ -57,7 +57,7 @@ public class HSQLDiskCacheFactory
* @param elementSerializer The serializer for cache elements
* @param keyMatcher The key matcher for getMatching() calls
* @return JDBCDiskCache
- * @throws SQLException if the creation of the cache instance fails
+ * @throws SQLException Thrown if the creation of the cache instance fails
*/
@Override
public <K, V> JDBCDiskCache<K, V> createCache( final
AuxiliaryCacheAttributes iaca,
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 673e75c0..9b9fbb01 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
@@ -52,7 +52,7 @@ public class MySQLDiskCache<K, V>
* @param attributes The configuration object for this cache
* @param dsFactory The DataSourceFactory for this cache
* @param tableState An object to track table operations
- * @throws SQLException if the pool access could not be set up
+ * @throws SQLException Thrown if the pool access could not be set up
*/
public MySQLDiskCache( final MySQLDiskCacheAttributes attributes, final
DataSourceFactory dsFactory,
final TableState tableState) throws SQLException
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLDiskCacheFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLDiskCacheFactory.java
index 88fe8d28..e2cb6c47 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLDiskCacheFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/mysql/MySQLDiskCacheFactory.java
@@ -71,7 +71,7 @@ public class MySQLDiskCacheFactory
* @param elementSerializer The serializer for cache elements
* @param keyMatcher The key matcher for getMatching() calls
* @return MySQLDiskCache the cache instance
- * @throws SQLException if the cache instance could not be created
+ * @throws SQLException Thrown if the cache instance could not be created
*/
@Override
public <K, V> MySQLDiskCache<K, V> createCache( final
AuxiliaryCacheAttributes rawAttr,
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 6e1b430a..7236c9a1 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
@@ -221,7 +221,7 @@ public class RemoteCacheManager
/**
* Lookup remote service from registry
- * @throws IOException if the remote service could not be found
+ * @throws IOException Thrown if the remote service could not be found
*/
protected void lookupRemoteService() throws IOException
{
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 00b20441..c855a912 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
@@ -237,7 +237,7 @@ public class RemoteCacheServerFactory
* @param config The configuration properties
* @param port The local port
* @return The admin object instance
- * @throws Exception if lookup fails
+ * @throws Exception Thrown 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/engine/behavior/IElementSerializer.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/IElementSerializer.java
index 2409a62a..3f41122a 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
@@ -45,7 +45,7 @@ public interface IElementSerializer
* @param bytes data bytes
* @param loader class loader to use
* @return Object
- * @throws IOException if de-serialization fails
+ * @throws IOException Thrown if de-serialization fails
* @throws ClassNotFoundException thrown if we don't know the object.
*/
<T> T deSerialize( byte[] bytes, ClassLoader loader )
@@ -61,7 +61,7 @@ public interface IElementSerializer
* @param ic The input channel
* @param readTimeoutMs The read timeout in milliseconds
* @param loader class loader to use
- * @throws IOException if serialization or reading fails
+ * @throws IOException Thrown if serialization or reading fails
* @throws ClassNotFoundException thrown if we don't know the object.
* @since 3.1
*/
@@ -128,7 +128,7 @@ public interface IElementSerializer
* @param <T> The type of the object
* @param is The input stream
* @param loader class loader to use
- * @throws IOException if serialization or reading fails
+ * @throws IOException Thrown if serialization or reading fails
* @throws ClassNotFoundException thrown if we don't know the object.
* @since 3.1
*/
@@ -146,7 +146,7 @@ public interface IElementSerializer
* @param <T> The type of the object
* @param ic The input channel
* @param loader class loader to use
- * @throws IOException if serialization or reading fails
+ * @throws IOException Thrown if serialization or reading fails
* @throws ClassNotFoundException thrown if we don't know the object.
* @since 3.1
*/
@@ -189,7 +189,7 @@ public interface IElementSerializer
* @param <T> The type of the object
* @param obj The object to serialize
* @return byte[] a byte array containing the serialized object
- * @throws IOException if serialization fails
+ * @throws IOException Thrown if serialization fails
*/
<T> byte[] serialize( T obj )
throws IOException;
@@ -204,7 +204,7 @@ public interface IElementSerializer
* @param oc The output channel
* @param writeTimeoutMs The write timeout im milliseconds
* @return The number of bytes written
- * @throws IOException if serialization or writing fails
+ * @throws IOException Thrown if serialization or writing fails
* @since 3.1
*/
default <T> int serializeTo(final T obj, final AsynchronousByteChannel oc,
final long writeTimeoutMs)
@@ -241,7 +241,7 @@ public interface IElementSerializer
* @param obj The object to serialize
* @param os The output stream
* @return The number of bytes written
- * @throws IOException if serialization or writing fails
+ * @throws IOException Thrown if serialization or writing fails
* @since 3.1
*/
default <T> int serializeTo(final T obj, final OutputStream os)
@@ -265,7 +265,7 @@ public interface IElementSerializer
* @param obj The object to serialize
* @param oc The output channel
* @return The number of bytes written
- * @throws IOException if serialization or writing fails
+ * @throws IOException Thrown if serialization or writing fails
* @since 3.1
*/
default <T> int serializeTo(final T obj, final WritableByteChannel oc)
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 4ebda561..3626716b 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
@@ -423,7 +423,7 @@ public class CompositeCacheManager
* Dispose a cache and remove it from the map of registered auxiliary
caches
*
* @param key The key into the map of auxiliaries
- * @throws IOException if disposing of the cache fails
+ * @throws IOException Thrown if disposing of the cache fails
*/
public void freeAuxiliaryCache(final String key) throws IOException
{
@@ -440,7 +440,7 @@ public class CompositeCacheManager
*
* @param auxName The auxiliary name
* @param cacheName The region name
- * @throws IOException if disposing of the cache fails
+ * @throws IOException Thrown if disposing of the cache fails
*/
public void freeAuxiliaryCache(final String auxName, final String
cacheName) throws IOException
{
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/HsqlSetupUtil.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/HsqlSetupUtil.java
index 5daf3bbc..09707831 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/HsqlSetupUtil.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/HsqlSetupUtil.java
@@ -69,7 +69,7 @@ public final class HsqlSetupUtil
*
* @param cConn
* @param tableName
- * @throws SQLException if database problems occur
+ * @throws SQLException Thrown if database problems occur
*/
public static void setupTable( final Connection cConn, final String
tableName ) throws SQLException
{
