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-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 3a8a2ae75 Javadoc
3a8a2ae75 is described below
commit 3a8a2ae751b12f35f734bbe350c6dab714a30141
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Aug 2 15:32:43 2026 -0400
Javadoc
---
.../commons/configuration2/ConfigurationXMLReader.java | 16 ++++++++--------
.../commons/configuration2/DatabaseConfiguration.java | 12 ++++++------
.../apache/commons/configuration2/INIConfiguration.java | 8 ++++----
.../commons/configuration2/PropertiesConfiguration.java | 12 ++++++------
.../configuration2/PropertiesConfigurationLayout.java | 2 +-
.../apache/commons/configuration2/XMLConfiguration.java | 6 +++---
.../commons/configuration2/beanutils/BeanFactory.java | 2 +-
.../configuration2/beanutils/DefaultBeanFactory.java | 6 +++---
.../builder/BuilderConfigurationWrapperFactory.java | 2 +-
.../combined/BaseConfigurationBuilderProvider.java | 10 +++++-----
.../commons/configuration2/interpol/ConstantLookup.java | 2 +-
.../org/apache/commons/configuration2/io/FileBased.java | 4 ++--
.../commons/configuration2/io/InputStreamSupport.java | 2 +-
.../commons/configuration2/io/URLConnectionOptions.java | 2 +-
.../commons/configuration2/resolver/CatalogResolver.java | 4 ++--
.../configuration2/DatabaseConfigurationTestHelper.java | 6 +++---
.../org/apache/commons/configuration2/TempDirUtils.java | 8 ++++----
.../commons/configuration2/TestINIConfiguration.java | 2 +-
...stReloadingCombinedConfigurationBuilderFileBased.java | 8 ++++----
.../commons/configuration2/io/TestFileHandler.java | 2 +-
.../reloading/TestVFSFileHandlerReloadingDetector.java | 2 +-
21 files changed, 59 insertions(+), 59 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/ConfigurationXMLReader.java
b/src/main/java/org/apache/commons/configuration2/ConfigurationXMLReader.java
index d0b1e2d47..2faf989b3 100644
---
a/src/main/java/org/apache/commons/configuration2/ConfigurationXMLReader.java
+++
b/src/main/java/org/apache/commons/configuration2/ConfigurationXMLReader.java
@@ -206,8 +206,8 @@ public abstract class ConfigurationXMLReader implements
XMLReader {
* Parses the actual configuration object. The passed input source will be
ignored.
*
* @param input The input source (ignored)
- * @throws IOException if no configuration was specified
- * @throws SAXException if an error occurs during parsing
+ * @throws IOException Thrown if no configuration was specified
+ * @throws SAXException Thrown if an error occurs during parsing
*/
@Override
public void parse(final InputSource input) throws IOException,
SAXException {
@@ -218,8 +218,8 @@ public abstract class ConfigurationXMLReader implements
XMLReader {
* Parses the current configuration object. The passed system ID will be
ignored.
*
* @param systemId The system ID (ignored)
- * @throws IOException if no configuration was specified
- * @throws SAXException if an error occurs during parsing
+ * @throws IOException Thrown if no configuration was specified
+ * @throws SAXException Thrown if an error occurs during parsing
*/
@Override
public void parse(final String systemId) throws IOException, SAXException {
@@ -229,8 +229,8 @@ public abstract class ConfigurationXMLReader implements
XMLReader {
/**
* Parses the configuration object and generates SAX events. This is the
main processing method.
*
- * @throws IOException if no configuration has been specified
- * @throws SAXException if an error occurs during parsing
+ * @throws IOException Thrown if no configuration has been specified
+ * @throws SAXException Thrown if an error occurs during parsing
*/
protected void parseConfiguration() throws IOException, SAXException {
if (getParsedConfiguration() == null) {
@@ -254,8 +254,8 @@ public abstract class ConfigurationXMLReader implements
XMLReader {
* {@code endElement()} methods and cares for exception handling. The
remaining actions are left to this method that
* must be implemented in a concrete sub class.
*
- * @throws IOException if an IO error occurs
- * @throws SAXException if a SAX error occurs
+ * @throws IOException Thrown if an IO error occurs
+ * @throws SAXException Thrown if a SAX error occurs
*/
protected abstract void processKeys() throws IOException, SAXException;
diff --git
a/src/main/java/org/apache/commons/configuration2/DatabaseConfiguration.java
b/src/main/java/org/apache/commons/configuration2/DatabaseConfiguration.java
index f3120b6e9..2314ebd3b 100644
--- a/src/main/java/org/apache/commons/configuration2/DatabaseConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/DatabaseConfiguration.java
@@ -169,7 +169,7 @@ public class DatabaseConfiguration extends
AbstractConfiguration {
* @param sql The statement to be executed
* @param nameCol A flag whether the configurationName column should
be taken into account
* @return The prepared statement object
- * @throws SQLException if an SQL error occurs
+ * @throws SQLException Thrown if an SQL error occurs
*/
protected PreparedStatement createStatement(final String sql, final
boolean nameCol) throws SQLException {
final String statement;
@@ -231,7 +231,7 @@ public class DatabaseConfiguration extends
AbstractConfiguration {
* @param nameCol A flag whether the configurationName column should
be taken into account
* @param params The parameters for the statement
* @return The initialized statement object
- * @throws SQLException if an SQL error occurs
+ * @throws SQLException Thrown if an SQL error occurs
*/
protected PreparedStatement initStatement(final String sql, final
boolean nameCol, final Object... params) throws SQLException {
final PreparedStatement ps = createStatement(sql, nameCol);
@@ -255,7 +255,7 @@ public class DatabaseConfiguration extends
AbstractConfiguration {
* @param nameCol A flag whether the configurationName column should
be taken into account
* @param params The parameters for the statement
* @return The {@code ResultSet} produced by the query
- * @throws SQLException if an SQL error occurs
+ * @throws SQLException Thrown if an SQL error occurs
*/
protected ResultSet openResultSet(final String sql, final boolean
nameCol, final Object... params) throws SQLException {
return resultSet = initStatement(sql, nameCol,
params).executeQuery();
@@ -266,7 +266,7 @@ public class DatabaseConfiguration extends
AbstractConfiguration {
* Here the actual JDBC logic has to be placed.
*
* @return The result of the operation
- * @throws SQLException if an SQL error occurs
+ * @throws SQLException Thrown if an SQL error occurs
*/
protected abstract T performOperation() throws SQLException;
}
@@ -291,7 +291,7 @@ public class DatabaseConfiguration extends
AbstractConfiguration {
*
* @param clob The CLOB to be converted
* @return The extracted string value
- * @throws SQLException if an error occurs
+ * @throws SQLException Thrown if an error occurs
*/
private static Object convertClob(final Clob clob) throws SQLException {
final int len = (int) clob.length();
@@ -508,7 +508,7 @@ public class DatabaseConfiguration extends
AbstractConfiguration {
*
* @param rs The current {@code ResultSet}
* @return The value of the property column
- * @throws SQLException if an error occurs
+ * @throws SQLException Thrown if an error occurs
*/
protected Object extractPropertyValue(final ResultSet rs) throws
SQLException {
Object value = rs.getObject(valueColumn);
diff --git
a/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
b/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
index 42bfc7273..6ed7d8add 100644
--- a/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
@@ -512,7 +512,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
* @param in The reader
* @param rootBuilder The builder for the top-level section
* @param sectionBuilders A map storing the section builders
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
private void createNodeBuilders(final BufferedReader in, final
ImmutableNode.Builder rootBuilder, final Map<String, ImmutableNode.Builder>
sectionBuilders)
throws IOException {
@@ -800,7 +800,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
*
* @param val The value to be parsed
* @param reader The reader (needed if multiple lines have to be read)
- * @throws IOException if an IO error occurs
+ * @throws IOException Thrown if an IO error occurs
*/
private String parseValue(final String val, final BufferedReader reader)
throws IOException {
final StringBuilder propertyValue = new StringBuilder();
@@ -873,7 +873,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
*
* @param in The reader to read the configuration from.
* @throws ConfigurationException If an error occurs while reading the
configuration
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void read(final Reader in) throws ConfigurationException,
IOException {
@@ -931,7 +931,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
*
* @param writer The writer to save the configuration to.
* @throws ConfigurationException If an error occurs while writing the
configuration
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void write(final Writer writer) throws ConfigurationException,
IOException {
diff --git
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
index 1ba9a8814..f7050fd14 100644
---
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
+++
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
@@ -646,7 +646,7 @@ public class PropertiesConfiguration extends
BaseConfiguration implements FileBa
* or whether further properties are available (<strong>true</strong>).
*
* @return A flag if further properties are available
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
* @since 1.3
*/
public boolean nextProperty() throws IOException {
@@ -924,7 +924,7 @@ public class PropertiesConfiguration extends
BaseConfiguration implements FileBa
* Writes a comment.
*
* @param comment The comment to write
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public void writeComment(final String comment) throws IOException {
writeln("# " + comment);
@@ -934,7 +934,7 @@ public class PropertiesConfiguration extends
BaseConfiguration implements FileBa
* Helper method for writing a line with the platform specific line
ending.
*
* @param s The content of the line (may be <strong>null</strong>)
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
* @since 1.3
*/
public void writeln(final String s) throws IOException {
@@ -949,7 +949,7 @@ public class PropertiesConfiguration extends
BaseConfiguration implements FileBa
*
* @param key The key of the property
* @param values The array of values of the property
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public void writeProperty(final String key, final List<?> values)
throws IOException {
for (final Object value : values) {
@@ -962,7 +962,7 @@ public class PropertiesConfiguration extends
BaseConfiguration implements FileBa
*
* @param key The key of the property
* @param value The value of the property
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public void writeProperty(final String key, final Object value) throws
IOException {
writeProperty(key, value, false);
@@ -975,7 +975,7 @@ public class PropertiesConfiguration extends
BaseConfiguration implements FileBa
* @param key The property key
* @param value The property value
* @param forceSingleLine The "force single line" flag
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
* @since 1.3
*/
public void writeProperty(final String key, final Object value, final
boolean forceSingleLine) throws IOException {
diff --git
a/src/main/java/org/apache/commons/configuration2/PropertiesConfigurationLayout.java
b/src/main/java/org/apache/commons/configuration2/PropertiesConfigurationLayout.java
index 886e5968a..17eb47f2c 100644
---
a/src/main/java/org/apache/commons/configuration2/PropertiesConfigurationLayout.java
+++
b/src/main/java/org/apache/commons/configuration2/PropertiesConfigurationLayout.java
@@ -356,7 +356,7 @@ public class PropertiesConfigurationLayout implements
EventListener<Configuratio
*
* @param writer The writer
* @param comment The comment to write
- * @throws IOException if an IO error occurs
+ * @throws IOException Thrown if an IO error occurs
*/
private static void writeComment(final
PropertiesConfiguration.PropertiesWriter writer, final String comment) throws
IOException {
if (comment != null) {
diff --git
a/src/main/java/org/apache/commons/configuration2/XMLConfiguration.java
b/src/main/java/org/apache/commons/configuration2/XMLConfiguration.java
index 5ae845899..fb97d08f3 100644
--- a/src/main/java/org/apache/commons/configuration2/XMLConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/XMLConfiguration.java
@@ -964,7 +964,7 @@ public class XMLConfiguration extends
BaseHierarchicalConfiguration implements F
*
* @param in The input stream.
* @throws ConfigurationException if an error occurs.
- * @throws IOException if an IO error occurs.
+ * @throws IOException Thrown if an IO error occurs.
*/
@Override
public void read(final InputStream in) throws ConfigurationException,
IOException {
@@ -977,7 +977,7 @@ public class XMLConfiguration extends
BaseHierarchicalConfiguration implements F
*
* @param in The reader.
* @throws ConfigurationException if an error occurs.
- * @throws IOException if an IO error occurs.
+ * @throws IOException Thrown if an IO error occurs.
*/
@Override
public void read(final Reader in) throws ConfigurationException,
IOException {
@@ -1101,7 +1101,7 @@ public class XMLConfiguration extends
BaseHierarchicalConfiguration implements F
*
* @param writer The writer used to save the configuration.
* @throws ConfigurationException if an error occurs.
- * @throws IOException if an IO error occurs.
+ * @throws IOException Thrown if an IO error occurs.
*/
@Override
public void write(final Writer writer) throws ConfigurationException,
IOException {
diff --git
a/src/main/java/org/apache/commons/configuration2/beanutils/BeanFactory.java
b/src/main/java/org/apache/commons/configuration2/beanutils/BeanFactory.java
index c95241736..c819c4f26 100644
--- a/src/main/java/org/apache/commons/configuration2/beanutils/BeanFactory.java
+++ b/src/main/java/org/apache/commons/configuration2/beanutils/BeanFactory.java
@@ -45,7 +45,7 @@ public interface BeanFactory {
*
* @param bcc The context object for the bean to be created
* @return The new bean instance (should not be <strong>null</strong>)
- * @throws Exception if an error occurs (the helper classes for creating
beans will catch this generic exception and
+ * @throws Exception Thrown if an error occurs (the helper classes for
creating beans will catch this generic exception and
* wrap it in a configuration exception)
*/
Object createBean(BeanCreationContext bcc) throws Exception;
diff --git
a/src/main/java/org/apache/commons/configuration2/beanutils/DefaultBeanFactory.java
b/src/main/java/org/apache/commons/configuration2/beanutils/DefaultBeanFactory.java
index 736bc3755..83b0e1b05 100644
---
a/src/main/java/org/apache/commons/configuration2/beanutils/DefaultBeanFactory.java
+++
b/src/main/java/org/apache/commons/configuration2/beanutils/DefaultBeanFactory.java
@@ -205,7 +205,7 @@ public class DefaultBeanFactory implements BeanFactory {
*
* @param bcc The context object defining the bean to be created
* @return The new bean instance
- * @throws Exception if an error occurs
+ * @throws Exception Thrown if an error occurs
*/
@Override
public Object createBean(final BeanCreationContext bcc) throws Exception {
@@ -220,7 +220,7 @@ public class DefaultBeanFactory implements BeanFactory {
*
* @param bcc The context object defining the bean to be created
* @return The new bean instance
- * @throws Exception if an error occurs
+ * @throws Exception Thrown if an error occurs
*/
protected Object createBeanInstance(final BeanCreationContext bcc) throws
Exception {
final Constructor<?> ctor =
findMatchingConstructor(bcc.getBeanClass(), bcc.getBeanDeclaration());
@@ -277,7 +277,7 @@ public class DefaultBeanFactory implements BeanFactory {
*
* @param bean The newly created bean instance
* @param bcc The context object defining the bean to be created
- * @throws Exception if an error occurs
+ * @throws Exception Thrown if an error occurs
*/
protected void initBeanInstance(final Object bean, final
BeanCreationContext bcc) throws Exception {
bcc.initBean(bean, bcc.getBeanDeclaration());
diff --git
a/src/main/java/org/apache/commons/configuration2/builder/BuilderConfigurationWrapperFactory.java
b/src/main/java/org/apache/commons/configuration2/builder/BuilderConfigurationWrapperFactory.java
index ba648c160..9c4766d35 100644
---
a/src/main/java/org/apache/commons/configuration2/builder/BuilderConfigurationWrapperFactory.java
+++
b/src/main/java/org/apache/commons/configuration2/builder/BuilderConfigurationWrapperFactory.java
@@ -76,7 +76,7 @@ public class BuilderConfigurationWrapperFactory {
* @param method The method to be invoked
* @param args method arguments
* @return The return value of the method
- * @throws Exception if an error occurs
+ * @throws Exception Thrown if an error occurs
*/
private Object handleConfigurationInvocation(final Method method,
final Object[] args) throws ReflectiveOperationException,
ConfigurationException {
return method.invoke(builder.getConfiguration(), args);
diff --git
a/src/main/java/org/apache/commons/configuration2/builder/combined/BaseConfigurationBuilderProvider.java
b/src/main/java/org/apache/commons/configuration2/builder/combined/BaseConfigurationBuilderProvider.java
index f3470b816..c10f94c22 100644
---
a/src/main/java/org/apache/commons/configuration2/builder/combined/BaseConfigurationBuilderProvider.java
+++
b/src/main/java/org/apache/commons/configuration2/builder/combined/BaseConfigurationBuilderProvider.java
@@ -67,7 +67,7 @@ public class BaseConfigurationBuilderProvider implements
ConfigurationBuilderPro
*
* @param paramcls The parameter class
* @return The newly created instance
- * @throws Exception if an error occurs
+ * @throws Exception Thrown if an error occurs
*/
private static BuilderParameters createParameterObject(final String
paramcls) throws ReflectiveOperationException {
return (BuilderParameters)
ConfigurationUtils.loadClass(paramcls).getConstructor().newInstance();
@@ -130,7 +130,7 @@ public class BaseConfigurationBuilderProvider implements
ConfigurationBuilderPro
* @param builder The builder to be initialized
* @param decl The current {@code ConfigurationDeclaration}
* @param params The collection with initialization parameter objects
- * @throws Exception if an error occurs
+ * @throws Exception Thrown if an error occurs
*/
protected void configureBuilder(final BasicConfigurationBuilder<? extends
Configuration> builder, final ConfigurationDeclaration decl,
final Collection<BuilderParameters> params) throws Exception {
@@ -145,7 +145,7 @@ public class BaseConfigurationBuilderProvider implements
ConfigurationBuilderPro
* @param decl The current {@code ConfigurationDeclaration}
* @param params initialization parameters for the new builder object
* @return The newly created builder instance
- * @throws Exception if an error occurs
+ * @throws Exception Thrown if an error occurs
*/
protected BasicConfigurationBuilder<? extends Configuration>
createBuilder(final ConfigurationDeclaration decl, final
Collection<BuilderParameters> params)
throws Exception {
@@ -164,7 +164,7 @@ public class BaseConfigurationBuilderProvider implements
ConfigurationBuilderPro
* the parameter classes passed to the constructor.
*
* @return A collection with parameter objects for the builder
- * @throws Exception if an error occurs while creating parameter objects
via reflection
+ * @throws Exception Thrown if an error occurs while creating parameter
objects via reflection
*/
protected Collection<BuilderParameters> createParameterObjects() throws
Exception {
final Collection<BuilderParameters> params = new
ArrayList<>(getParameterClasses().size());
@@ -286,7 +286,7 @@ public class BaseConfigurationBuilderProvider implements
ConfigurationBuilderPro
*
* @param decl The current {@code ConfigurationDeclaration}
* @param params The collection with (uninitialized) parameter objects
- * @throws Exception if an error occurs
+ * @throws Exception Thrown if an error occurs
*/
protected void initializeParameterObjects(final ConfigurationDeclaration
decl, final Collection<BuilderParameters> params) throws Exception {
inheritParentBuilderProperties(decl, params);
diff --git
a/src/main/java/org/apache/commons/configuration2/interpol/ConstantLookup.java
b/src/main/java/org/apache/commons/configuration2/interpol/ConstantLookup.java
index 1aaa94fc0..e00a23c59 100644
---
a/src/main/java/org/apache/commons/configuration2/interpol/ConstantLookup.java
+++
b/src/main/java/org/apache/commons/configuration2/interpol/ConstantLookup.java
@@ -113,7 +113,7 @@ public class ConstantLookup implements Lookup {
* @param className The name of the class
* @param fieldName The name of the member field of that class to read
* @return The field's value
- * @throws Exception if an error occurs
+ * @throws Exception Thrown if an error occurs
*/
protected Object resolveField(final String className, final String
fieldName) throws Exception {
return fetchClass(className).getField(fieldName).get(null);
diff --git a/src/main/java/org/apache/commons/configuration2/io/FileBased.java
b/src/main/java/org/apache/commons/configuration2/io/FileBased.java
index 288a63427..da924c468 100644
--- a/src/main/java/org/apache/commons/configuration2/io/FileBased.java
+++ b/src/main/java/org/apache/commons/configuration2/io/FileBased.java
@@ -47,7 +47,7 @@ public interface FileBased {
* use a {@code FileHandler} for reading data.</strong>
*
* @param in The reader
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @throws ConfigurationException if a non-I/O related problem occurs, for
example the data read does not have the expected
* format
*/
@@ -58,7 +58,7 @@ public interface FileBased {
* use a {@code FileHandler} for writing data.</strong>
*
* @param out The writer
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @throws ConfigurationException if a non-I/O related problem occurs, for
example the data read does not have the expected
* format
*/
diff --git
a/src/main/java/org/apache/commons/configuration2/io/InputStreamSupport.java
b/src/main/java/org/apache/commons/configuration2/io/InputStreamSupport.java
index b1c1c84b5..43bd1973d 100644
--- a/src/main/java/org/apache/commons/configuration2/io/InputStreamSupport.java
+++ b/src/main/java/org/apache/commons/configuration2/io/InputStreamSupport.java
@@ -44,7 +44,7 @@ public interface InputStreamSupport {
* @param in The input stream
* @throws ConfigurationException if a non-I/O related problem occurs, for
example the data read does not have the expected
* format
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
void read(InputStream in) throws ConfigurationException, IOException;
}
diff --git
a/src/main/java/org/apache/commons/configuration2/io/URLConnectionOptions.java
b/src/main/java/org/apache/commons/configuration2/io/URLConnectionOptions.java
index 52ed05738..b9a14c4e6 100644
---
a/src/main/java/org/apache/commons/configuration2/io/URLConnectionOptions.java
+++
b/src/main/java/org/apache/commons/configuration2/io/URLConnectionOptions.java
@@ -145,7 +145,7 @@ public final class URLConnectionOptions {
*
* @param url The URL to open
* @return A new connection
- * @throws IOException if an I/O exception occurs.
+ * @throws IOException Thrown if an I/O exception occurs.
*/
public URLConnection openConnection(final URL url) throws IOException {
return apply(url.openConnection());
diff --git
a/src/main/java/org/apache/commons/configuration2/resolver/CatalogResolver.java
b/src/main/java/org/apache/commons/configuration2/resolver/CatalogResolver.java
index abd97ab2a..7e232604c 100644
---
a/src/main/java/org/apache/commons/configuration2/resolver/CatalogResolver.java
+++
b/src/main/java/org/apache/commons/configuration2/resolver/CatalogResolver.java
@@ -63,7 +63,7 @@ public class CatalogResolver implements EntityResolver {
/**
* Load the catalogs.
*
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
@Override
public void loadSystemCatalogs() throws IOException {
@@ -401,7 +401,7 @@ public class CatalogResolver implements EntityResolver {
* @param systemId The system identifier for the entity in question. XML
requires a system identifier on all external
* entities, so this value is always specified.
* @return An InputSource for the mapped identifier, or null.
- * @throws SAXException if an error occurs.
+ * @throws SAXException Thrown if an error occurs.
*/
@SuppressWarnings("resource") // InputSource wraps an InputStream.
@Override
diff --git
a/src/test/java/org/apache/commons/configuration2/DatabaseConfigurationTestHelper.java
b/src/test/java/org/apache/commons/configuration2/DatabaseConfigurationTestHelper.java
index 05f06a074..73efd229f 100644
---
a/src/test/java/org/apache/commons/configuration2/DatabaseConfigurationTestHelper.java
+++
b/src/test/java/org/apache/commons/configuration2/DatabaseConfigurationTestHelper.java
@@ -135,7 +135,7 @@ public class DatabaseConfigurationTestHelper {
* Initializes this helper object. This method can be called from a {@code
setUp()} method of a unit test class. It
* creates the database instance if necessary.
*
- * @throws Exception if an error occurs
+ * @throws Exception Thrown if an error occurs
*/
public void setUp() throws Exception {
final File script = ConfigurationAssert.getTestFile("testdb.script");
@@ -168,7 +168,7 @@ public class DatabaseConfigurationTestHelper {
* Creates the internal data source. This method also initializes the
database.
*
* @return The data source
- * @throws Exception if an error occurs
+ * @throws Exception Thrown if an error occurs
*/
private DataSource setUpDataSource() throws Exception {
final BasicDataSource ds = new BasicDataSource();
@@ -243,7 +243,7 @@ public class DatabaseConfigurationTestHelper {
* Frees the resources used by this helper class. This method can be
called by a {@code tearDown()} method of a unit
* test class.
*
- * @throws Exception if an error occurs
+ * @throws Exception Thrown if an error occurs
*/
public void tearDown() throws Exception {
if (dataSource != null) {
diff --git a/src/test/java/org/apache/commons/configuration2/TempDirUtils.java
b/src/test/java/org/apache/commons/configuration2/TempDirUtils.java
index 0ca56acf4..24a30ffdf 100644
--- a/src/test/java/org/apache/commons/configuration2/TempDirUtils.java
+++ b/src/test/java/org/apache/commons/configuration2/TempDirUtils.java
@@ -36,7 +36,7 @@ public final class TempDirUtils {
*
* @param tempFolder The temporary folder to create the file under
* @return The created file
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public static File newFile(final File tempFolder) throws IOException {
return Files.createTempFile(tempFolder.toPath(), TMP_PREFIX,
null).toFile();
@@ -47,7 +47,7 @@ public final class TempDirUtils {
*
* @param tempFolder The temporary folder to create the file under
* @return The created file
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public static File newFile(final String fileName, final File tempFolder)
throws IOException {
return
Files.createFile(tempFolder.toPath().resolve(fileName)).toFile();
@@ -58,7 +58,7 @@ public final class TempDirUtils {
*
* @param tempFolder The temporary folder to create the folder under
* @return The created folder
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public static File newFolder(final File tempFolder) throws IOException {
return Files.createTempDirectory(tempFolder.toPath(),
TMP_PREFIX).toFile();
@@ -69,7 +69,7 @@ public final class TempDirUtils {
*
* @param tempFolder The temporary folder to create the folder under
* @return The created folder
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
public static File newFolder(final String path, final File tempFolder)
throws IOException {
return
Files.createDirectory(tempFolder.toPath().resolve(path)).toFile();
diff --git
a/src/test/java/org/apache/commons/configuration2/TestINIConfiguration.java
b/src/test/java/org/apache/commons/configuration2/TestINIConfiguration.java
index 11229e7e9..6130d0633 100644
--- a/src/test/java/org/apache/commons/configuration2/TestINIConfiguration.java
+++ b/src/test/java/org/apache/commons/configuration2/TestINIConfiguration.java
@@ -1109,7 +1109,7 @@ public class TestINIConfiguration {
*
* @param content The content of the file
* @return The newly created file
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
private File writeTestFile(final String content) throws IOException {
final File file = newFile(tempFolder);
diff --git
a/src/test/java/org/apache/commons/configuration2/builder/combined/TestReloadingCombinedConfigurationBuilderFileBased.java
b/src/test/java/org/apache/commons/configuration2/builder/combined/TestReloadingCombinedConfigurationBuilderFileBased.java
index 3fb1e0e4b..52d7fcc5c 100644
---
a/src/test/java/org/apache/commons/configuration2/builder/combined/TestReloadingCombinedConfigurationBuilderFileBased.java
+++
b/src/test/java/org/apache/commons/configuration2/builder/combined/TestReloadingCombinedConfigurationBuilderFileBased.java
@@ -149,7 +149,7 @@ public class
TestReloadingCombinedConfigurationBuilderFileBased {
*
* @param file The file to be written
* @param content The file's content
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
private static void writeFile(final File file, final String content)
throws IOException {
try (PrintWriter out = new PrintWriter(new FileWriter(file))) {
@@ -172,7 +172,7 @@ public class
TestReloadingCombinedConfigurationBuilderFileBased {
* builder has been fully initialized.
*
* @param defFile The path to the definition file
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @throws ConfigurationException if a configuration-related error occurs
* @throws InterruptedException if waiting is interrupted
*/
@@ -312,7 +312,7 @@ public class
TestReloadingCombinedConfigurationBuilderFileBased {
* @param tagIdx The index of the tag
* @param value The value of the reload test property
* @return The file that was written
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
private File writeReloadFile(final File f, final int tagIdx, final int
value) throws IOException {
return writeReloadFile(f, MessageFormat.format(RELOAD_CONTENT, value,
tagIdx));
@@ -325,7 +325,7 @@ public class
TestReloadingCombinedConfigurationBuilderFileBased {
* @param f The file to be written or <strong>null</strong> for creating a
new one
* @param content The content of the file
* @return The {@code File} object for the test file
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
private File writeReloadFile(final File f, final String content) throws
IOException {
final File file = f != null ? f : newFile(tempFolder);
diff --git
a/src/test/java/org/apache/commons/configuration2/io/TestFileHandler.java
b/src/test/java/org/apache/commons/configuration2/io/TestFileHandler.java
index 580c0fa04..f286d5088 100644
--- a/src/test/java/org/apache/commons/configuration2/io/TestFileHandler.java
+++ b/src/test/java/org/apache/commons/configuration2/io/TestFileHandler.java
@@ -263,7 +263,7 @@ public class TestFileHandler {
*
* @param in The reader
* @return The read content
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
private static String readReader(final Reader in) throws IOException {
final StringBuilder buf = new StringBuilder();
diff --git
a/src/test/java/org/apache/commons/configuration2/reloading/TestVFSFileHandlerReloadingDetector.java
b/src/test/java/org/apache/commons/configuration2/reloading/TestVFSFileHandlerReloadingDetector.java
index ba08cee23..a081f8b21 100644
---
a/src/test/java/org/apache/commons/configuration2/reloading/TestVFSFileHandlerReloadingDetector.java
+++
b/src/test/java/org/apache/commons/configuration2/reloading/TestVFSFileHandlerReloadingDetector.java
@@ -155,7 +155,7 @@ public class TestVFSFileHandlerReloadingDetector {
*
* @param file The file to be written
* @param value The value of the test property
- * @throws IOException if an error occurs
+ * @throws IOException Thrown if an error occurs
*/
private void writeTestFile(final File file, final String value) throws
IOException {
try (FileWriter out = new FileWriter(file)) {
