(commons-configuration) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 97f9d8b2 Javadoc
97f9d8b2 is described below
commit 97f9d8b2bf88b9c8d138b920c3ea41a7dbe61e5b
Author: Gary Gregory
AuthorDate: Sun Jul 21 11:26:01 2024 -0400
Javadoc
Use HTML 'em' tag instead of 'i' tag
---
.../apache/commons/configuration2/PropertiesConfiguration.java| 8
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
index 7d8a0491..8c13b568 100644
---
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
+++
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
@@ -76,19 +76,19 @@ import org.apache.commons.text.translate.UnicodeEscaper;
*
*
*
- * The key may use any character, separators must be escaped:
+ * The key may use any character, separators must be escaped:
*
*
* key\:foo = bar
*
*
*
- * value may be separated on different lines if a backslash is
placed at the end of the line that continues
+ * value may be separated on different lines if a backslash is
placed at the end of the line that continues
* below.
* The list delimiter facilities provided by {@link AbstractConfiguration}
are supported, too. If an appropriate
* {@link ListDelimiterHandler} is set (for instance a
* {@link
org.apache.commons.configuration2.convert.DefaultListDelimiterHandler D
efaultListDelimiterHandler} object
- * configured with a comma as delimiter character), value can contain
value delimiters and will then be
+ * configured with a comma as delimiter character), value can contain
value delimiters and will then be
* interpreted as a list of tokens. So the following property definition
*
*
@@ -99,7 +99,7 @@ import org.apache.commons.text.translate.UnicodeEscaper;
* {@link AbstractConfiguration#setListDelimiterHandler(ListDelimiterHandler)}
method. Per default, list splitting is
* disabled.
* Commas in each token are escaped placing a backslash right before the
comma.
- * If a key is used more than once, the values are appended like if
they were on the same line separated with
+ * If a key is used more than once, the values are appended like
if they were on the same line separated with
* commas. Note: When the configuration file is written back to disk
the associated
* {@link PropertiesConfigurationLayout} object (see below) will try to
preserve as much of the original format as
* possible, i.e. properties with multiple values defined on a single line
will also be written back on a single line,
(commons-configuration) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new b6bc2c29 Javadoc
b6bc2c29 is described below
commit b6bc2c29107e2d9bcf51a21ef6b047e661090df3
Author: Gary Gregory
AuthorDate: Mon Jul 1 09:41:57 2024 -0400
Javadoc
---
.../apache/commons/configuration2/TestSubsetConfiguration440.java| 5 +
1 file changed, 1 insertion(+), 4 deletions(-)
diff --git
a/src/test/java/org/apache/commons/configuration2/TestSubsetConfiguration440.java
b/src/test/java/org/apache/commons/configuration2/TestSubsetConfiguration440.java
index d7d18715..a70abb0b 100644
---
a/src/test/java/org/apache/commons/configuration2/TestSubsetConfiguration440.java
+++
b/src/test/java/org/apache/commons/configuration2/TestSubsetConfiguration440.java
@@ -34,13 +34,10 @@ import org.junit.jupiter.api.Test;
// import org.junit.Test;
/**
- * Test case for the {@link SubsetConfiguration} class.
+ * Tests https://issues.apache.org/jira/browse/CONFIGURATION-848";>CONFIGURATION-848
and {@link SubsetConfiguration}.
*/
public class TestSubsetConfiguration440 {
-/**
- * Tests CONFIGURATION-848.
- */
@Test
@Disabled
public void testSubsetConfigurationWithIndexAndDelimiter() throws
ConfigurationException, IOException {
(commons-configuration) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new d4dfc469 Javadoc
d4dfc469 is described below
commit d4dfc4695c0159572d4fe77c781da30c6a554628
Author: Gary Gregory
AuthorDate: Sun Jun 30 11:16:53 2024 -0400
Javadoc
---
.../java/org/apache/commons/configuration2/PrefixedKeysIterator.java| 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/PrefixedKeysIterator.java
b/src/main/java/org/apache/commons/configuration2/PrefixedKeysIterator.java
index 96bb280b..4ee2d7da 100644
--- a/src/main/java/org/apache/commons/configuration2/PrefixedKeysIterator.java
+++ b/src/main/java/org/apache/commons/configuration2/PrefixedKeysIterator.java
@@ -111,7 +111,7 @@ final class PrefixedKeysIterator implements
Iterator {
}
/**
- * Determines the next element in the iteration. The return value
indicates whether such an element can be found.
+ * Sets the next element in the iteration. The return value indicates
whether such an element can be found.
*
* @return a flag whether a next element exists
*/
(commons-configuration) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new da007a35 Javadoc
da007a35 is described below
commit da007a352b11906e787e3002b2a4e5b7a35d2088
Author: Gary Gregory
AuthorDate: Sun Jun 30 11:08:15 2024 -0400
Javadoc
---
.../commons/configuration2/PrefixedKeysIterator.java | 16
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/PrefixedKeysIterator.java
b/src/main/java/org/apache/commons/configuration2/PrefixedKeysIterator.java
index 2e403169..96bb280b 100644
--- a/src/main/java/org/apache/commons/configuration2/PrefixedKeysIterator.java
+++ b/src/main/java/org/apache/commons/configuration2/PrefixedKeysIterator.java
@@ -21,14 +21,14 @@ import java.util.Iterator;
import java.util.NoSuchElementException;
/**
- * * A specialized iterator implementation used by {@link
AbstractConfiguration} to return an iteration over all keys
+ * A specialized iterator implementation used by {@link AbstractConfiguration}
to return an iteration over all keys
* starting with a specified prefix.
- *
*
* This class is basically a stripped-down version of the {@code
FilterIterator} class of Commons Collections
*
*/
final class PrefixedKeysIterator implements Iterator {
+
/** Stores the wrapped iterator. */
private final Iterator iterator;
@@ -55,12 +55,12 @@ final class PrefixedKeysIterator implements
Iterator {
this(wrappedIterator, keyPrefix, ".");
}
- /**
- * Creates a new instance of {@code PrefixedKeysIterator} and sets the
wrapped iterator and the prefix as well as
- * the delimiter for the preix for the accepted keys.
+/**
+ * Creates a new instance of {@code PrefixedKeysIterator} and sets the
wrapped iterator and the prefix as well as the delimiter for the preix for the
+ * accepted keys.
*
* @param wrappedIterator the wrapped iterator
- * @param keyPrefix the prefix of the allowed keys
+ * @param keyPrefix the prefix of the allowed keys
* @param prefixDelimiter the prefix delimiter
* @since 2.10.0
*/
@@ -71,9 +71,9 @@ final class PrefixedKeysIterator implements Iterator {
}
/**
- * Returns a flag whether there are more elements in the iteration.
+ * Tests whether there are more elements in the iteration.
*
- * @return a flag if there is a next element
+ * @return whether there are more elements in the iteration.
*/
@Override
public boolean hasNext() {
(commons-configuration) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new d2815b69 Javadoc
d2815b69 is described below
commit d2815b6953d577525e9c15c17724fdde12717dbe
Author: Gary Gregory
AuthorDate: Sat May 18 09:45:29 2024 -0400
Javadoc
---
.../configuration2/tree/xpath/ConfigurationNodePointerFactory.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/tree/xpath/ConfigurationNodePointerFactory.java
b/src/main/java/org/apache/commons/configuration2/tree/xpath/ConfigurationNodePointerFactory.java
index 5ccde9ad..8aed8aba 100644
---
a/src/main/java/org/apache/commons/configuration2/tree/xpath/ConfigurationNodePointerFactory.java
+++
b/src/main/java/org/apache/commons/configuration2/tree/xpath/ConfigurationNodePointerFactory.java
@@ -25,7 +25,7 @@ import org.apache.commons.jxpath.ri.model.NodePointerFactory;
/**
*
- * Implementation of the {@code NodePointerFactory} interface for
configuration nodes.
+ * Implements the {@code NodePointerFactory} interface for configuration nodes.
*
*
* This class is able to create {@code NodePointer}s for the nodes of
hierarchical configurations. Because there is no
(commons-configuration) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 4a6ba6da Javadoc
4a6ba6da is described below
commit 4a6ba6dae26b43b71410ea655f94f272d30c0e59
Author: Gary Gregory
AuthorDate: Tue May 7 10:07:48 2024 -0400
Javadoc
---
.../builder/combined/CombinedConfigurationBuilder.java | 9 +
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/builder/combined/CombinedConfigurationBuilder.java
b/src/main/java/org/apache/commons/configuration2/builder/combined/CombinedConfigurationBuilder.java
index dd576798..e80e3b1a 100644
---
a/src/main/java/org/apache/commons/configuration2/builder/combined/CombinedConfigurationBuilder.java
+++
b/src/main/java/org/apache/commons/configuration2/builder/combined/CombinedConfigurationBuilder.java
@@ -286,10 +286,11 @@ public class CombinedConfigurationBuilder extends
BasicConfigurationBuilder>
createAndAddConfigurations(final CombinedConfiguration ccResult,
final List srcDecl, final
List> builders) throws
ConfigurationException {
(commons-configuration) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 8ab15861 Javadoc
8ab15861 is described below
commit 8ab15861148fd15b93f7f162e96c9e197cdb
Author: Gary Gregory
AuthorDate: Tue May 7 09:58:56 2024 -0400
Javadoc
Whitespace
---
src/test/java/org/apache/commons/configuration2/test/HsqlDB.java | 6 +-
1 file changed, 1 insertion(+), 5 deletions(-)
diff --git a/src/test/java/org/apache/commons/configuration2/test/HsqlDB.java
b/src/test/java/org/apache/commons/configuration2/test/HsqlDB.java
index 4ba1af15..f96aa71a 100644
--- a/src/test/java/org/apache/commons/configuration2/test/HsqlDB.java
+++ b/src/test/java/org/apache/commons/configuration2/test/HsqlDB.java
@@ -30,7 +30,7 @@ import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
- * Stolen from Turbine
+ * Sourced from Apache Turbine.
*/
public class HsqlDB {
@@ -40,9 +40,7 @@ public class HsqlDB {
public HsqlDB(final String uri, final String databaseDriver, final String
loadFile) throws Exception {
Class.forName(databaseDriver);
-
this.connection = DriverManager.getConnection(uri, "sa", "");
-
if (StringUtils.isNotEmpty(loadFile)) {
loadSqlFile(loadFile);
}
@@ -67,7 +65,6 @@ public class HsqlDB {
private void loadSqlFile(final String fileName) throws Exception {
try (Statement statement = connection.createStatement()) {
String commands = getFileContents(fileName);
-
for (int targetPos = commands.indexOf(';'); targetPos > -1;
targetPos = commands.indexOf(';')) {
final String cmd = commands.substring(0, targetPos + 1);
try {
@@ -75,7 +72,6 @@ public class HsqlDB {
} catch (final SQLException sqle) {
LOG.warn("Statement: " + cmd + ": " + sqle.getMessage());
}
-
commands = commands.substring(targetPos + 2);
}
}
(commons-configuration) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 641ad793 Javadoc
641ad793 is described below
commit 641ad7939ae724059c3a777dea2b8ecf0a9c46b5
Author: Gary Gregory
AuthorDate: Wed Jan 17 10:28:59 2024 -0500
Javadoc
---
.../org/apache/commons/configuration2/CompositeConfiguration.java | 4 ++--
.../java/org/apache/commons/configuration2/DataConfiguration.java | 2 +-
.../java/org/apache/commons/configuration2/INIConfiguration.java | 2 +-
.../java/org/apache/commons/configuration2/JNDIConfiguration.java | 4 ++--
.../java/org/apache/commons/configuration2/MapConfiguration.java | 2 +-
.../apache/commons/configuration2/PropertiesConfiguration.java| 2 +-
.../org/apache/commons/configuration2/SubsetConfiguration.java| 8
.../java/org/apache/commons/configuration2/io/FileHandler.java| 4 ++--
.../org/apache/commons/configuration2/io/FileLocatorUtils.java| 2 +-
.../commons/configuration2/resolver/EntityResolverSupport.java| 2 +-
.../apache/commons/configuration2/TestAbstractConfiguration.java | 4 ++--
11 files changed, 18 insertions(+), 18 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/CompositeConfiguration.java
b/src/main/java/org/apache/commons/configuration2/CompositeConfiguration.java
index ba5e9d48..129aff7b 100644
---
a/src/main/java/org/apache/commons/configuration2/CompositeConfiguration.java
+++
b/src/main/java/org/apache/commons/configuration2/CompositeConfiguration.java
@@ -230,7 +230,7 @@ public class CompositeConfiguration extends
AbstractConfiguration implements Clo
}
/**
- * Return the number of configurations.
+ * Gets the number of configurations.
*
* @return the number of configuration
*/
@@ -356,7 +356,7 @@ public class CompositeConfiguration extends
AbstractConfiguration implements Clo
}
/**
- * Return the configuration at the specified index.
+ * Gets the configuration at the specified index.
*
* @param index The index of the configuration to retrieve
* @return the configuration at this index
diff --git
a/src/main/java/org/apache/commons/configuration2/DataConfiguration.java
b/src/main/java/org/apache/commons/configuration2/DataConfiguration.java
index 6c1b5174..318b2333 100644
--- a/src/main/java/org/apache/commons/configuration2/DataConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/DataConfiguration.java
@@ -150,7 +150,7 @@ public class DataConfiguration extends
AbstractConfiguration {
}
/**
- * Return the configuration decorated by this DataConfiguration.
+ * Gets the configuration decorated by this DataConfiguration.
*
* @return the wrapped configuration
*/
diff --git
a/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
b/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
index 4d98cfe1..4749d930 100644
--- a/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
@@ -806,7 +806,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
}
/**
- * Return a set containing the sections in this ini configuration. Note
that changes to this set do not affect the
+ * Gets a set containing the sections in this ini configuration. Note that
changes to this set do not affect the
* configuration.
*
* @return a set containing the sections.
diff --git
a/src/main/java/org/apache/commons/configuration2/JNDIConfiguration.java
b/src/main/java/org/apache/commons/configuration2/JNDIConfiguration.java
index c37162a9..92915626 100644
--- a/src/main/java/org/apache/commons/configuration2/JNDIConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/JNDIConfiguration.java
@@ -371,7 +371,7 @@ public class JNDIConfiguration extends
AbstractConfiguration {
}
/**
- * Return the base context with the prefix applied.
+ * Gets the base context with the prefix applied.
*
* @return the base context
* @throws NamingException if an error occurs
@@ -385,7 +385,7 @@ public class JNDIConfiguration extends
AbstractConfiguration {
}
/**
- * Return the initial context used by this configuration. This context is
independent of the prefix specified.
+ * Gets the initial context used by this configuration. This context is
independent of the prefix specified.
*
* @return the initial context
*/
diff --git
a/src/main/java/org/apache/commons/configuration2/MapConfiguration.java
b/src/main/java/org/apache/commons/configuration2/MapConfiguration.java
index 5d0f5d55..c42591e8 100644
--- a/src/main/java/org/apache/comm
(commons-configuration) branch master updated: Javadoc and comments: Use an HTTPS URL
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 2b4d32af Javadoc and comments: Use an HTTPS URL
2b4d32af is described below
commit 2b4d32af86e77e87eff573a39a2b0b3c89183214
Author: Gary Gregory
AuthorDate: Sun Jan 14 10:58:22 2024 -0500
Javadoc and comments: Use an HTTPS URL
---
.../java/org/apache/commons/configuration2/io/DefaultFileSystem.java| 2 +-
.../java/org/apache/commons/configuration2/io/FileLocatorUtils.java | 2 +-
.../apache/commons/configuration2/plist/PropertyListConfiguration.java | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/io/DefaultFileSystem.java
b/src/main/java/org/apache/commons/configuration2/io/DefaultFileSystem.java
index 6587f881..75c46e43 100644
--- a/src/main/java/org/apache/commons/configuration2/io/DefaultFileSystem.java
+++ b/src/main/java/org/apache/commons/configuration2/io/DefaultFileSystem.java
@@ -59,7 +59,7 @@ public class DefaultFileSystem extends FileSystem {
@Override
public OutputStream getOutputStream(final URL url) throws
ConfigurationException {
// file URLs have to be converted to Files since FileURLConnection is
-// read only
(http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4191800)
+// read only
(https://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4191800)
final File file = FileLocatorUtils.fileFromURL(url);
if (file != null) {
return getOutputStream(file);
diff --git
a/src/main/java/org/apache/commons/configuration2/io/FileLocatorUtils.java
b/src/main/java/org/apache/commons/configuration2/io/FileLocatorUtils.java
index 4e01656f..6f0978ad 100644
--- a/src/main/java/org/apache/commons/configuration2/io/FileLocatorUtils.java
+++ b/src/main/java/org/apache/commons/configuration2/io/FileLocatorUtils.java
@@ -292,7 +292,7 @@ public final class FileLocatorUtils {
}
/**
- * Return the path without the file name, for example
http://xyz.net/foo/bar.xml results in http://xyz.net/foo/
+ * Return the path without the file name, for example
https://xyz.net/foo/bar.xml results in https://xyz.net/foo/
*
* @param url the URL from which to extract the path
* @return the path component of the passed in URL
diff --git
a/src/main/java/org/apache/commons/configuration2/plist/PropertyListConfiguration.java
b/src/main/java/org/apache/commons/configuration2/plist/PropertyListConfiguration.java
index 2a804691..fa038a9a 100644
---
a/src/main/java/org/apache/commons/configuration2/plist/PropertyListConfiguration.java
+++
b/src/main/java/org/apache/commons/configuration2/plist/PropertyListConfiguration.java
@@ -49,7 +49,7 @@ import org.apache.commons.lang3.StringUtils;
* References:
*
* http://developer.apple.com/documentation/Cocoa/Conceptual/PropertyLists/OldStylePlists/OldStylePLists.html";>
Apple
+ *
"https://developer.apple.com/documentation/Cocoa/Conceptual/PropertyLists/OldStylePlists/OldStylePLists.html";>
Apple
* Documentation - Old-Style ASCII Property Lists
* http://www.gnustep.org/resources/documentation/Developer/Base/Reference/NSPropertyList.html";>
GNUStep
* Documentation
(commons-configuration) branch master updated: Javadoc spelling
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-configuration.git The following commit(s) were added to refs/heads/master by this push: new fef03999 Javadoc spelling new 1371b905 Merge branch 'master' of https://gitbox.apache.org/repos/asf/commons-configuration fef03999 is described below commit fef039996fe938d6bb538f5488081e9ba50b6fa7 Author: Gary Gregory AuthorDate: Fri Dec 29 15:42:11 2023 -0500 Javadoc spelling --- .../commons/configuration2/plist/XMLPropertyListConfiguration.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/configuration2/plist/XMLPropertyListConfiguration.java b/src/main/java/org/apache/commons/configuration2/plist/XMLPropertyListConfiguration.java index cc1711a5..462100fb 100644 --- a/src/main/java/org/apache/commons/configuration2/plist/XMLPropertyListConfiguration.java +++ b/src/main/java/org/apache/commons/configuration2/plist/XMLPropertyListConfiguration.java @@ -63,7 +63,7 @@ import org.xml.sax.SAXException; import org.xml.sax.helpers.DefaultHandler; /** - * Property list file (plist) in XML FORMAT as used by Mac OS X (http://www.apple.com/DTDs/PropertyList-1.0.dtd). This + * Property list file (plist) in XML FORMAT as used by macOS X (http://www.apple.com/DTDs/PropertyList-1.0.dtd). This * configuration doesn't support the binary FORMAT used in OS X 10.4. * *
(commons-configuration) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new c0267e80 Javadoc
c0267e80 is described below
commit c0267e809e5b379b8e220610c1dab04238843f17
Author: Gary Gregory
AuthorDate: Sun Dec 17 14:31:15 2023 -0500
Javadoc
---
src/main/java/org/apache/commons/configuration2/MapConfiguration.java | 4 ++--
.../org/apache/commons/configuration2/PropertiesConfiguration.java| 2 +-
.../commons/configuration2/convert/DefaultConversionHandler.java | 2 +-
.../apache/commons/configuration2/convert/ListDelimiterHandler.java | 2 +-
4 files changed, 5 insertions(+), 5 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/MapConfiguration.java
b/src/main/java/org/apache/commons/configuration2/MapConfiguration.java
index faf844cc..5d0f5d55 100644
--- a/src/main/java/org/apache/commons/configuration2/MapConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/MapConfiguration.java
@@ -31,14 +31,14 @@ import
org.apache.commons.configuration2.ex.ConfigurationRuntimeException;
* A Map based Configuration.
*
*
- * This implementation of the {@code Configuration} interface is initialized
with a {@code java.util.Map}. The methods
+ * This implementation of the {@code Configuration} interface is initialized
with a {@link java.util.Map}. The methods
* of the {@code Configuration} interface are implemented on top of the
content of this map. The following storage
* scheme is used:
*
*
* Property keys are directly mapped to map keys, i.e. the {@code
getProperty()} method directly performs a
* {@code get()} on the map. Analogously, {@code setProperty()} or {@code
addProperty()} operations write new data into
- * the map. If a value is added to an existing property, a {@code
java.util.List} is created, which stores the values of
+ * the map. If a value is added to an existing property, a {@link
java.util.List} is created, which stores the values of
* this property.
*
*
diff --git
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
index 7f843a0e..7df8c981 100644
---
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
+++
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
@@ -1005,7 +1005,7 @@ public class PropertiesConfiguration extends
BaseConfiguration implements FileBa
/**
* A string with special characters that need to be unescaped when reading
a properties file.
- * {@code java.util.Properties} escapes these characters when writing out
a properties file.
+ * {@link java.util.Properties} escapes these characters when writing out
a properties file.
*/
private static final String UNESCAPE_CHARACTERS = ":#=!\\\'\"";
diff --git
a/src/main/java/org/apache/commons/configuration2/convert/DefaultConversionHandler.java
b/src/main/java/org/apache/commons/configuration2/convert/DefaultConversionHandler.java
index d56ca0a7..7f53a429 100644
---
a/src/main/java/org/apache/commons/configuration2/convert/DefaultConversionHandler.java
+++
b/src/main/java/org/apache/commons/configuration2/convert/DefaultConversionHandler.java
@@ -233,7 +233,7 @@ public class DefaultConversionHandler implements
ConversionHandler {
/**
* Sets the date format to be used by this conversion handler. This format
is applied by conversions to {@code Date} or
- * {@code Calendar} objects. The string is passed to the {@code
java.text.SimpleDateFormat} class, so it must be
+ * {@code Calendar} objects. The string is passed to the {@link
java.text.SimpleDateFormat} class, so it must be
* compatible with this class. If no date format has been set, a default
format is used.
*
* @param dateFormat the date format string
diff --git
a/src/main/java/org/apache/commons/configuration2/convert/ListDelimiterHandler.java
b/src/main/java/org/apache/commons/configuration2/convert/ListDelimiterHandler.java
index 090587cb..9ddd57e8 100644
---
a/src/main/java/org/apache/commons/configuration2/convert/ListDelimiterHandler.java
+++
b/src/main/java/org/apache/commons/configuration2/convert/ListDelimiterHandler.java
@@ -30,7 +30,7 @@ import java.util.List;
* {@link org.apache.commons.configuration2.AbstractConfiguration
AbstractConfiguration} supports list delimiters in
* property values. If such a delimiter is found, the value actually contains
multiple values and has to be split. This
* is useful for instance for {@link
org.apache.commons.configuration2.PropertiesConfiguration
PropertiesConfiguration}:
- * properties files that have to be compatible with the {@code
java.util.Properties} class cannot have multiple
+ * properties
(commons-configuration) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 8c96d9a2 Javadoc
8c96d9a2 is described below
commit 8c96d9a2c938397a13ed290d4aeec0e63736334f
Author: Gary Gregory
AuthorDate: Thu Dec 14 13:48:53 2023 -0500
Javadoc
---
.../java/org/apache/commons/configuration2/BaseConfiguration.java | 2 +-
.../configuration2/spring/ConfigurationPropertiesFactoryBean.java | 4 ++--
.../commons/configuration2/tree/DefaultExpressionEngineSymbols.java | 4 ++--
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/BaseConfiguration.java
b/src/main/java/org/apache/commons/configuration2/BaseConfiguration.java
index f4a3d8fe..73474b66 100644
--- a/src/main/java/org/apache/commons/configuration2/BaseConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/BaseConfiguration.java
@@ -34,7 +34,7 @@ import
org.apache.commons.configuration2.ex.ConfigurationRuntimeException;
* value strings instead of overwriting them.
*/
public class BaseConfiguration extends AbstractConfiguration implements
Cloneable {
-/** stores the configuration key-value pairs */
+/** Stores the configuration key-value pairs */
private Map store = new LinkedHashMap<>();
/**
diff --git
a/src/main/java/org/apache/commons/configuration2/spring/ConfigurationPropertiesFactoryBean.java
b/src/main/java/org/apache/commons/configuration2/spring/ConfigurationPropertiesFactoryBean.java
index ed01e33c..d8e523cf 100644
---
a/src/main/java/org/apache/commons/configuration2/spring/ConfigurationPropertiesFactoryBean.java
+++
b/src/main/java/org/apache/commons/configuration2/spring/ConfigurationPropertiesFactoryBean.java
@@ -46,10 +46,10 @@ import org.springframework.util.Assert;
*/
public class ConfigurationPropertiesFactoryBean implements InitializingBean,
FactoryBean {
-/** internal CompositeConfiguration containing the merged configuration
objects **/
+/** Internal CompositeConfiguration containing the merged configuration
objects **/
private CompositeConfiguration compositeConfiguration;
-/** supplied configurations that will be merged in compositeConfiguration
**/
+/** Supplied configurations that will be merged in compositeConfiguration
**/
private Configuration[] configurations;
/** Spring resources for loading configurations **/
diff --git
a/src/main/java/org/apache/commons/configuration2/tree/DefaultExpressionEngineSymbols.java
b/src/main/java/org/apache/commons/configuration2/tree/DefaultExpressionEngineSymbols.java
index 4026a8d3..f4fc3eff 100644
---
a/src/main/java/org/apache/commons/configuration2/tree/DefaultExpressionEngineSymbols.java
+++
b/src/main/java/org/apache/commons/configuration2/tree/DefaultExpressionEngineSymbols.java
@@ -74,7 +74,7 @@ public final class DefaultExpressionEngineSymbols {
/** Stores the index start marker. */
private final String indexStart;
-/** stores the index end marker. */
+/** Stores the index end marker. */
private final String indexEnd;
/**
@@ -219,7 +219,7 @@ public final class DefaultExpressionEngineSymbols {
/** Stores the index start marker. */
private String indexStart;
-/** stores the index end marker. */
+/** Stores the index end marker. */
private String indexEnd;
/**
(commons-configuration) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 7a20cec4 Javadoc
7a20cec4 is described below
commit 7a20cec474a46497eac2e253eefffbf0b5b022a5
Author: Gary Gregory
AuthorDate: Thu Dec 14 09:45:05 2023 -0500
Javadoc
---
.../org/apache/commons/configuration2/PropertiesConfiguration.java| 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
index 2082a2ee..7f843a0e 100644
---
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
+++
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
@@ -313,7 +313,7 @@ public class PropertiesConfiguration extends
BaseConfiguration implements FileBa
public static class JupPropertiesReader extends PropertiesReader {
/**
- * Constructor.
+ * Constructs a new instance.
*
* @param reader A Reader.
*/
@@ -481,7 +481,7 @@ public class PropertiesConfiguration extends
BaseConfiguration implements FileBa
private String propertySeparator = DEFAULT_SEPARATOR;
/**
- * Constructor.
+ * Constructs a new instance.
*
* @param reader A Reader.
*/
(commons-configuration) branch master updated: Javadoc: Remove redundant "java.lang" prefix
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 4bb3c600 Javadoc: Remove redundant "java.lang" prefix
4bb3c600 is described below
commit 4bb3c600d41815c507db2dcc25ada2e604da9bbd
Author: Gary Gregory
AuthorDate: Sat Dec 9 10:04:07 2023 -0500
Javadoc: Remove redundant "java.lang" prefix
---
src/main/java/org/apache/commons/configuration2/DataConfiguration.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/DataConfiguration.java
b/src/main/java/org/apache/commons/configuration2/DataConfiguration.java
index b318cbd4..6c1b5174 100644
--- a/src/main/java/org/apache/commons/configuration2/DataConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/DataConfiguration.java
@@ -47,7 +47,7 @@ import org.apache.commons.lang3.StringUtils;
* {@link java.net.InetAddress}
* {@code javax.mail.internet.InternetAddress} (requires Javamail in the
classpath)
* {@code jakarta.mail.internet.InternetAddress} (requires Javamail 2.+ in
the classpath)
- * {@link java.lang.Enum} (Java 5 enumeration types)
+ * {@link Enum} (Java 5 enumeration types)
*
*
* Lists and arrays are available for all types.
(commons-configuration) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 001e9135 Javadoc
001e9135 is described below
commit 001e9135a629fd1f611d6f368e1c541ce39377b0
Author: Gary Gregory
AuthorDate: Sat Nov 11 16:12:21 2023 -0500
Javadoc
---
.../commons/configuration2/interpol/ConfigurationInterpolator.java| 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/interpol/ConfigurationInterpolator.java
b/src/main/java/org/apache/commons/configuration2/interpol/ConfigurationInterpolator.java
index bcba9c7d..bf6dd01a 100644
---
a/src/main/java/org/apache/commons/configuration2/interpol/ConfigurationInterpolator.java
+++
b/src/main/java/org/apache/commons/configuration2/interpol/ConfigurationInterpolator.java
@@ -617,7 +617,7 @@ public class ConfigurationInterpolator {
private final Map defaultLookups;
/**
- * Construct a new instance initialized with the given properties.
+ * Constructs a new instance initialized with the given properties.
* @param props initialization properties
*/
DefaultPrefixLookupsHolder(final Properties props) {
@@ -663,7 +663,7 @@ public class ConfigurationInterpolator {
}
/**
- * Construct a lookup map by parsing the given string. The string is
expected to contain
+ * Constructs a lookup map by parsing the given string. The string is
expected to contain
* comma or space-separated names of values from the {@link
DefaultLookups} enum.
* @param str string to parse; not null
* @return lookup map parsed from the given string
[commons-configuration] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 35e0ecf8 Javadoc
35e0ecf8 is described below
commit 35e0ecf8d0462505f2386428e18b6ecad68ce4b1
Author: Gary Gregory
AuthorDate: Thu Oct 19 09:09:51 2023 -0400
Javadoc
---
.../commons/configuration2/builder/DatabaseBuilderParametersImpl.java | 4 ++--
.../commons/configuration2/builder/DatabaseBuilderProperties.java | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/builder/DatabaseBuilderParametersImpl.java
b/src/main/java/org/apache/commons/configuration2/builder/DatabaseBuilderParametersImpl.java
index 008e0672..eecc2c26 100644
---
a/src/main/java/org/apache/commons/configuration2/builder/DatabaseBuilderParametersImpl.java
+++
b/src/main/java/org/apache/commons/configuration2/builder/DatabaseBuilderParametersImpl.java
@@ -61,8 +61,8 @@ public class DatabaseBuilderParametersImpl extends
BasicBuilderParameters implem
}
@Override
-public DatabaseBuilderParametersImpl setTable(final String tname) {
-storeProperty(PROP_TABLE, tname);
+public DatabaseBuilderParametersImpl setTable(final String tableName) {
+storeProperty(PROP_TABLE, tableName);
return this;
}
diff --git
a/src/main/java/org/apache/commons/configuration2/builder/DatabaseBuilderProperties.java
b/src/main/java/org/apache/commons/configuration2/builder/DatabaseBuilderProperties.java
index c54a3ca0..18b23190 100644
---
a/src/main/java/org/apache/commons/configuration2/builder/DatabaseBuilderProperties.java
+++
b/src/main/java/org/apache/commons/configuration2/builder/DatabaseBuilderProperties.java
@@ -49,10 +49,10 @@ public interface DatabaseBuilderProperties {
* Sets the name of the table containing configuration data. Database
configuration will access this database table.
* This is a mandatory property.
*
- * @param tname the name of the table with configuration data
+ * @param name the name of the table with configuration data
* @return a reference to this object for method chaining
*/
-T setTable(String tname);
+T setTable(String name);
/**
* Sets the name of the table column containing configuration keys. This
is a mandatory property.
[commons-configuration] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 87623d4c Javadoc
87623d4c is described below
commit 87623d4c37e831d097c94a64918325609deefc61
Author: Gary Gregory
AuthorDate: Sat Mar 25 09:04:30 2023 -0400
Javadoc
---
.../apache/commons/configuration2/DatabaseConfigurationTestHelper.java | 1 -
1 file changed, 1 deletion(-)
diff --git
a/src/test/java/org/apache/commons/configuration2/DatabaseConfigurationTestHelper.java
b/src/test/java/org/apache/commons/configuration2/DatabaseConfigurationTestHelper.java
index e2f54de8..7ae9f866 100644
---
a/src/test/java/org/apache/commons/configuration2/DatabaseConfigurationTestHelper.java
+++
b/src/test/java/org/apache/commons/configuration2/DatabaseConfigurationTestHelper.java
@@ -39,7 +39,6 @@ import org.dbunit.operation.DatabaseOperation;
* A helper class for performing tests for {@link DatabaseConfiguration}. This
class maintains an in-process database
* that stores configuration data and can be accessed from a {@link
DatabaseConfiguration} instance. Constants for table
* and column names and database connection settings are provided, too.
- *
*/
public class DatabaseConfigurationTestHelper {
/** Constant for the configuration table. */
[commons-configuration] branch master updated: Javadoc fixes
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 7e959be6 Javadoc fixes
7e959be6 is described below
commit 7e959be6a0fa4ab2a7d3275d16bc64d01b20c25a
Author: Gary Gregory
AuthorDate: Fri Jan 13 14:42:12 2023 -0500
Javadoc fixes
---
.../org/apache/commons/configuration2/ImmutableConfiguration.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
b/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
index a3171197..b6c8d7f2 100644
---
a/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
+++
b/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
@@ -243,7 +243,7 @@ public interface ImmutableConfiguration {
* {@link #getCollection(Class, String, Collection, Collection)} passing
in null as default value.
*
* @param the element type of the result list
- * @param cls the the element class of the result list
+ * @param cls the element class of the result list
* @param key the configuration key
* @param target the target collection (may be null)
* @return the collection to which data was added
@@ -268,7 +268,7 @@ public interface ImmutableConfiguration {
*
*
* @param the element type of the result list
- * @param cls the the element class of the result list
+ * @param cls the element class of the result list
* @param key the configuration key
* @param target the target collection (may be null)
* @param defaultValue the default value (may be null)
[commons-configuration] branch master updated: Javadoc @see tags do not need to use a FQCN for classes in java.lang
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 23a935d1 Javadoc @see tags do not need to use a FQCN for classes in
java.lang
23a935d1 is described below
commit 23a935d11680eda1f7aa51a2735ce581f90f06cb
Author: Gary Gregory
AuthorDate: Mon Aug 29 07:08:55 2022 -0400
Javadoc @see tags do not need to use a FQCN for classes in java.lang
---
src/main/java/org/apache/commons/configuration2/ConfigurationMap.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/ConfigurationMap.java
b/src/main/java/org/apache/commons/configuration2/ConfigurationMap.java
index 0b47e419..7b554c6b 100644
--- a/src/main/java/org/apache/commons/configuration2/ConfigurationMap.java
+++ b/src/main/java/org/apache/commons/configuration2/ConfigurationMap.java
@@ -77,7 +77,7 @@ public class ConfigurationMap extends AbstractMap {
* @param key the key (will be converted to a string)
* @param value the value
* @return the old value of this key or null if it is new
- * @see java.util.Map#put(java.lang.Object, java.lang.Object)
+ * @see java.util.Map#put(Object, Object)
*/
@Override
public Object put(final Object key, final Object value) {
@@ -93,7 +93,7 @@ public class ConfigurationMap extends AbstractMap {
*
* @param key the key
* @return the value of this key
- * @see java.util.Map#get(java.lang.Object)
+ * @see java.util.Map#get(Object)
*/
@Override
public Object get(final Object key) {
[commons-configuration] branch master updated: javadoc and spotbug fixes
This is an automated email from the ASF dual-hosted git repository.
mattjuntunen 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 736fba93 javadoc and spotbug fixes
736fba93 is described below
commit 736fba9313dbce5042ca5dda5e9f2236ce5c6e0c
Author: Matt Juntunen
AuthorDate: Sat Jun 18 22:57:10 2022 -0400
javadoc and spotbug fixes
---
pom.xml| 3 ++
.../configuration2/CombinedConfiguration.java | 9 --
.../interpol/ConfigurationInterpolator.java| 34 ++---
.../configuration2/interpol/DefaultLookups.java| 35 +++---
.../configuration2/tree/InMemoryNodeModel.java | 2 +-
5 files changed, 44 insertions(+), 39 deletions(-)
diff --git a/pom.xml b/pom.xml
index 5762d3ed..7fb102fe 100644
--- a/pom.xml
+++ b/pom.xml
@@ -782,6 +782,7 @@
https://docs.oracle.com/javase/8/docs/api/
https://docs.spring.io/spring/docs/${spring.version}/javadoc-api/
+
https://commons.apache.org/proper/commons-text/javadocs/api-release/
@@ -911,6 +912,7 @@
https://docs.oracle.com/javase/8/docs/api/
https://docs.spring.io/spring/docs/${spring.version}/javadoc-api/
+
https://commons.apache.org/proper/commons-text/javadocs/api-release/
none
@@ -922,6 +924,7 @@
https://docs.oracle.com/javase/8/docs/api/
https://docs.spring.io/spring/docs/${spring.version}/javadoc-api/
+
https://commons.apache.org/proper/commons-text/javadocs/api-release/
diff --git
a/src/main/java/org/apache/commons/configuration2/CombinedConfiguration.java
b/src/main/java/org/apache/commons/configuration2/CombinedConfiguration.java
index 1ae005fc..909680b4 100644
--- a/src/main/java/org/apache/commons/configuration2/CombinedConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/CombinedConfiguration.java
@@ -653,14 +653,17 @@ public class CombinedConfiguration extends
BaseHierarchicalConfiguration impleme
return;
}
+boolean success = false;
try {
if (!isUpToDate()) {
getSubConfigurationParentModel().replaceRoot(constructCombinedNode(), this);
upToDate = true;
}
-} catch (final RuntimeException rex) {
-endWrite();
-throw rex;
+success = true;
+} finally {
+if (!success) {
+endWrite();
+}
}
}
diff --git
a/src/main/java/org/apache/commons/configuration2/interpol/ConfigurationInterpolator.java
b/src/main/java/org/apache/commons/configuration2/interpol/ConfigurationInterpolator.java
index 25e7c9d3..ba74a452 100644
---
a/src/main/java/org/apache/commons/configuration2/interpol/ConfigurationInterpolator.java
+++
b/src/main/java/org/apache/commons/configuration2/interpol/ConfigurationInterpolator.java
@@ -206,59 +206,59 @@ public class ConfigurationInterpolator {
* Lookup
*
*
- * {@value
org.apache.commons.text.lookup.StringLookupFactory#KEY_BASE64_DECODER}
+ * "base64Decoder"
* {@link DefaultLookups#BASE64_DECODER BASE64_DECODER}
*
*
- * {@value
org.apache.commons.text.lookup.StringLookupFactory#KEY_BASE64_ENCODER}
+ * "base64Encoder"
* {@link DefaultLookups#BASE64_ENCODER BASE64_ENCODER}
*
*
- * {@value
org.apache.commons.text.lookup.StringLookupFactory#KEY_CONST}
+ * "const"
* {@link DefaultLookups#CONST CONST}
*
*
- * {@value
org.apache.commons.text.lookup.StringLookupFactory#KEY_DATE}
+ * "date"
* {@link DefaultLookups#DATE DATE}
*
*
- * {@value
org.apache.commons.text.lookup.StringLookupFactory#KEY_ENV}
+ * "env"
* {@link DefaultLookups#ENVIRONMENT ENVIRONMENT}
*
*
- * {@value
org.apache.commons.text.lookup.StringLookupFactory#KEY_FILE}
+ * "file"
* {@link DefaultLookups#FILE FILE}
*
*
- * {@value
org.apache.commons.text.lookup.StringLookupFactory#KEY_JAVA}
+ * "java"
* {@link DefaultLookups#JAVA JAVA}
*
*
- * {@value
org.apache.commons.text.lookup.StringLookupFactory#KEY_LOCALHOST}
+ * "localhost"
* {@link DefaultLookups#LOCAL_HOST LOCAL_HOST}
*
*
- * {@value
org.apache.commons.text.lookup.StringLookupFactory#KEY_PROPERTIES}
+ * "properties"
* {@link DefaultLookups#PROPERTIES PROPERTIES}
*
*
- * {@value
org.apache.commons.text.lookup.StringLookupFactory#KEY_RESOURCE_BUNDLE}
+ * "resourceBundle"
* {@link
[commons-configuration] branch master updated: Javadoc and format tweaks
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new a49bd6d5 Javadoc and format tweaks
a49bd6d5 is described below
commit a49bd6d51f1c2226fa01db63f6c2698e3fa72435
Author: Gary Gregory
AuthorDate: Thu Jun 16 15:55:12 2022 -0400
Javadoc and format tweaks
---
.../apache/commons/configuration2/builder/ConfigurationBuilder.java| 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/builder/ConfigurationBuilder.java
b/src/main/java/org/apache/commons/configuration2/builder/ConfigurationBuilder.java
index 3a9b1023..e00bc89e 100644
---
a/src/main/java/org/apache/commons/configuration2/builder/ConfigurationBuilder.java
+++
b/src/main/java/org/apache/commons/configuration2/builder/ConfigurationBuilder.java
@@ -40,8 +40,9 @@ import
org.apache.commons.configuration2.ex.ConfigurationException;
* @param the concrete type of the {@code ImmutableConfiguration} class
produced by this builder
*/
public interface ConfigurationBuilder
extends EventSource {
+
/**
- * Returns the configuration provided by this builder. An implementation
has to perform all necessary steps for creating
+ * Gets the configuration provided by this builder. An implementation has
to perform all necessary steps for creating
* and initializing a {@code ImmutableConfiguration} object.
*
* @return the configuration
[commons-configuration] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new de6a67d2 Javadoc
de6a67d2 is described below
commit de6a67d237124120afe5f099d900517ab03611ae
Author: Gary Gregory
AuthorDate: Tue May 24 10:46:57 2022 -0400
Javadoc
---
.../beanutils/BeanCreationContext.java | 7 +--
.../configuration2/beanutils/BeanDeclaration.java | 13 +++---
.../configuration2/beanutils/BeanFactory.java | 5 ++-
.../configuration2/beanutils/BeanHelper.java | 23 +-
.../beanutils/CombinedBeanDeclaration.java | 3 +-
.../beanutils/ConfigurationDynaBean.java | 5 ++-
.../beanutils/ConfigurationDynaClass.java | 3 +-
.../configuration2/beanutils/ConstructorArg.java | 11 ++---
.../beanutils/DefaultBeanFactory.java | 15 ---
.../beanutils/XMLBeanDeclaration.java | 52 +++---
10 files changed, 74 insertions(+), 63 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/beanutils/BeanCreationContext.java
b/src/main/java/org/apache/commons/configuration2/beanutils/BeanCreationContext.java
index 52e6a0f9..b58a35d6 100644
---
a/src/main/java/org/apache/commons/configuration2/beanutils/BeanCreationContext.java
+++
b/src/main/java/org/apache/commons/configuration2/beanutils/BeanCreationContext.java
@@ -29,15 +29,16 @@ package org.apache.commons.configuration2.beanutils;
* @since 2.0
*/
public interface BeanCreationContext {
+
/**
- * Returns the class of the bean to be created.
+ * Gets the class of the bean to be created.
*
* @return the bean class
*/
Class getBeanClass();
/**
- * Returns the {@code BeanDeclaration} with the data for the new bean.
This data is used to initialize the bean's
+ * Gets the {@code BeanDeclaration} with the data for the new bean. This
data is used to initialize the bean's
* properties.
*
* @return the {@code BeanDeclaration} defining the bean to be created
@@ -45,7 +46,7 @@ public interface BeanCreationContext {
BeanDeclaration getBeanDeclaration();
/**
- * Returns the (optional) parameter object for the bean factory. This is a
mechanism which can be used to pass custom
+ * Gets the (optional) parameter object for the bean factory. This is a
mechanism which can be used to pass custom
* parameters to a {@link BeanFactory}.
*
* @return the parameter for the bean factory
diff --git
a/src/main/java/org/apache/commons/configuration2/beanutils/BeanDeclaration.java
b/src/main/java/org/apache/commons/configuration2/beanutils/BeanDeclaration.java
index ac7b904c..6218b09d 100644
---
a/src/main/java/org/apache/commons/configuration2/beanutils/BeanDeclaration.java
+++
b/src/main/java/org/apache/commons/configuration2/beanutils/BeanDeclaration.java
@@ -40,8 +40,9 @@ import java.util.Map;
* @since 1.3
*/
public interface BeanDeclaration {
+
/**
- * Returns the name of the {@code BeanFactory} that should be used for
creating the bean instance. This can be
+ * Gets the name of the {@code BeanFactory} that should be used for
creating the bean instance. This can be
* null, then a default factory will be used.
*
* @return the name of the bean factory
@@ -49,7 +50,7 @@ public interface BeanDeclaration {
String getBeanFactoryName();
/**
- * Here an arbitrary object can be returned that will be passed to the
bean factory. Its meaning is not further
+ * Gets an arbitrary object that will be passed to the bean factory. Its
meaning is not further
* specified. The purpose of this additional parameter is to support a
further configuration of the bean factory that
* can be placed directly at the bean declaration.
*
@@ -58,7 +59,7 @@ public interface BeanDeclaration {
Object getBeanFactoryParameter();
/**
- * Returns the name of the bean class, from which an instance is to be
created. This value must be defined unless a
+ * Gets the name of the bean class, from which an instance is to be
created. This value must be defined unless a
* default class is provided for the bean creation operation.
*
* @return the name of the bean class
@@ -66,7 +67,7 @@ public interface BeanDeclaration {
String getBeanClassName();
/**
- * Returns a map with properties that should be initialized on the newly
created bean. The map's keys are the names of
+ * Gets a map with properties that should be initialized on the newly
created bean. The map's keys are the names of
* the properties; the corresponding values are the properties' values.
The return value can be null if no
* properties should be set.
*
@@ -75,7 +76,7 @@ public interface BeanD
[commons-configuration] branch master updated: [Javadoc] Specify that typed getList returns null for missing key #100.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-configuration.git The following commit(s) were added to refs/heads/master by this push: new 1c0b292 [Javadoc] Specify that typed getList returns null for missing key #100. 1c0b292 is described below commit 1c0b29209171b2bf99510a39bc80781819bcd9b1 Author: Gary Gregory AuthorDate: Sat Jun 26 11:44:18 2021 -0400 [Javadoc] Specify that typed getList returns null for missing key #100. --- src/changes/changes.xml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 9bdc202..4d50181 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -43,6 +43,9 @@ Use try with resource #114. + + [Javadoc] Specify that typed getList returns null for missing key #100. + Implement Iterable in ImmutableNode #74.
[commons-configuration] branch master updated: Javadoc: Sentences end in a period.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 150d7aa Javadoc: Sentences end in a period.
150d7aa is described below
commit 150d7aac8d767d21064ef38557f4b9f4a59f79f1
Author: Gary Gregory
AuthorDate: Fri Jan 22 13:40:15 2021 -0500
Javadoc: Sentences end in a period.
---
.../java/org/apache/commons/configuration2/INIConfiguration.java| 6 +++---
.../org/apache/commons/configuration2/PropertiesConfiguration.java | 6 +++---
src/main/java/org/apache/commons/configuration2/io/FileBased.java | 4 ++--
.../org/apache/commons/configuration2/io/InputStreamSupport.java| 2 +-
.../TestReloadingCombinedConfigurationBuilderFileBased.java | 2 +-
5 files changed, 10 insertions(+), 10 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
b/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
index 1b93946..2b47f17 100644
--- a/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
@@ -408,7 +408,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements
* @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 if an I/O error occurs.
*/
@Override
public void write(final Writer writer) throws ConfigurationException,
IOException
@@ -463,7 +463,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements
* @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 if an I/O error occurs.
*/
@Override
public void read(final Reader in) throws ConfigurationException,
IOException
@@ -505,7 +505,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements
* @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 if an I/O error occurs.
*/
private void createNodeBuilders(final BufferedReader in,
final ImmutableNode.Builder rootBuilder,
diff --git
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
index 8df6738..42c08e1 100644
---
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
+++
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
@@ -1060,7 +1060,7 @@ public class PropertiesConfiguration extends
BaseConfiguration
* Write a comment.
*
* @param comment the comment to write
- * @throws IOException if an I/O error occurs
+ * @throws IOException if an I/O error occurs.
*/
public void writeComment(final String comment) throws IOException
{
@@ -1090,7 +1090,7 @@ public class PropertiesConfiguration extends
BaseConfiguration
* @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 if an I/O error occurs.
*/
public void writeProperty(final String key, final List values)
throws IOException
{
@@ -1105,7 +1105,7 @@ public class PropertiesConfiguration extends
BaseConfiguration
* @param key the key of the property
* @param value the value of the property
*
- * @throws IOException if an I/O error occurs
+ * @throws IOException if an I/O error occurs.
*/
public void writeProperty(final String key, final Object value) throws
IOException
{
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 1531793..f92da0e 100644
--- a/src/main/java/org/apache/commons/configuration2/io/FileBased.java
+++ b/src/main/java/org/apache/commons/configuration2/io/FileBased.java
@@ -53,7 +53,7 @@ public interface FileBased
* {@code FileHandler} for reading data.
*
* @param in the reader
- * @throws IOException if an I/O error occurs
+ * @throws IOException if an I/O error occurs.
* @throws ConfigurationException if a non-I/O related problem occurs, e.g.
* the d
[commons-configuration] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new eaebda8 Javadoc.
eaebda8 is described below
commit eaebda829fe7a008348a15428fc9ad2ee78fb9d3
Author: Gary Gregory
AuthorDate: Tue Sep 15 09:43:13 2020 -0400
Javadoc.
---
.../java/org/apache/commons/configuration2/io/FileLocatorUtils.java | 4
1 file changed, 4 insertions(+)
diff --git
a/src/main/java/org/apache/commons/configuration2/io/FileLocatorUtils.java
b/src/main/java/org/apache/commons/configuration2/io/FileLocatorUtils.java
index 9ef8311..f6ce481 100644
--- a/src/main/java/org/apache/commons/configuration2/io/FileLocatorUtils.java
+++ b/src/main/java/org/apache/commons/configuration2/io/FileLocatorUtils.java
@@ -465,6 +465,10 @@ public final class FileLocatorUtils
* file.toURI().toURL().
*
* @param file the file to be converted into an URL
+ * @return a URL
+ * @throws MalformedURLException
+ * If the file protocol handler is not found (should not happen)
+ * or if an error occurred while constructing the URL
*/
static URL toURL(final File file) throws MalformedURLException
{
[commons-configuration] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 41fe67e Javadoc.
41fe67e is described below
commit 41fe67e6bb0ca91e0a9107baa4c8021384f0d27f
Author: Gary Gregory
AuthorDate: Mon Apr 27 14:44:09 2020 -0400
Javadoc.
---
.../configuration2/ImmutableConfiguration.java | 90 +++---
1 file changed, 45 insertions(+), 45 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
b/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
index d2e7d93..b78b66f 100644
---
a/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
+++
b/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
@@ -53,7 +53,7 @@ import
org.apache.commons.configuration2.ex.ConversionException;
public interface ImmutableConfiguration
{
/**
- * Check if the configuration is empty.
+ * Checks if the configuration is empty.
*
* @return {@code true} if the configuration contains no property,
* {@code false} otherwise.
@@ -72,7 +72,7 @@ public interface ImmutableConfiguration
int size();
/**
- * Check if the configuration contains the specified key.
+ * Checks if the configuration contains the specified key.
*
* @param key the key whose presence in this configuration is to be tested
*
@@ -100,7 +100,7 @@ public interface ImmutableConfiguration
Object getProperty(String key);
/**
- * Get the list of the keys contained in the configuration that match the
+ * Gets the list of the keys contained in the configuration that match the
* specified prefix. For instance, if the configuration contains the
* following keys:
* {@code db.user, db.pwd, db.url, window.xpos, window.ypos},
@@ -118,7 +118,7 @@ public interface ImmutableConfiguration
Iterator getKeys(String prefix);
/**
- * Get the list of the keys contained in the configuration. The returned
+ * Gets the list of the keys contained in the configuration. The returned
* iterator can be used to obtain all defined keys. It does not allow
* removing elements from this configuration via its {@code remove()}
* method. Note that the keys of this configuration are returned in a form,
@@ -130,7 +130,7 @@ public interface ImmutableConfiguration
Iterator getKeys();
/**
- * Get a list of properties associated with the given configuration key.
This method
+ * Gets a list of properties associated with the given configuration key.
This method
* expects the given key to have an arbitrary number of String values,
each of which
* is of the form {@code key=value}. These strings are split at the equals
sign, and
* the key parts will become keys of the returned {@code Properties}
object, the value
@@ -146,7 +146,7 @@ public interface ImmutableConfiguration
Properties getProperties(String key);
/**
- * Get a boolean associated with the given configuration key.
+ * Gets a boolean associated with the given configuration key.
*
* @param key The configuration key.
* @return The associated boolean.
@@ -156,7 +156,7 @@ public interface ImmutableConfiguration
boolean getBoolean(String key);
/**
- * Get a boolean associated with the given configuration key. If the key
doesn't map
+ * Gets a boolean associated with the given configuration key. If the key
doesn't map
* to an existing object, the default value is returned.
*
* @param key The configuration key.
@@ -168,7 +168,7 @@ public interface ImmutableConfiguration
boolean getBoolean(String key, boolean defaultValue);
/**
- * Get a {@link Boolean} associated with the given configuration key.
+ * Gets a {@link Boolean} associated with the given configuration key.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -180,7 +180,7 @@ public interface ImmutableConfiguration
Boolean getBoolean(String key, Boolean defaultValue);
/**
- * Get a byte associated with the given configuration key.
+ * Gets a byte associated with the given configuration key.
*
* @param key The configuration key.
* @return The associated byte.
@@ -190,7 +190,7 @@ public interface ImmutableConfiguration
byte getByte(String key);
/**
- * Get a byte associated with the given configuration key. If the key
doesn't map to
+ * Gets a byte associated with the given configuration key. If the key
doesn't map to
* an existing object, the default value is returned.
*
* @param key The configuration key.
@@ -202,7 +202,7 @@ public interface ImmutableConfigurat
[commons-configuration] branch master updated: Javadoc: Replace HTML tags with Javadoc {@code} notation.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new b773e0c Javadoc: Replace HTML tags with Javadoc {@code}
notation.
b773e0c is described below
commit b773e0c309c5fbbe0ab4d36cd47370759589571b
Author: Gary Gregory
AuthorDate: Mon Dec 9 23:08:46 2019 -0500
Javadoc: Replace HTML tags with Javadoc {@code} notation.
---
.../configuration2/AbstractConfiguration.java | 4 +--
.../configuration2/PropertiesConfiguration.java| 6 ++--
.../PropertiesConfigurationLayout.java | 4 +--
.../configuration2/beanutils/package-info.java | 4 +--
.../combined/CombinedConfigurationBuilder.java | 2 +-
.../configuration2/convert/package-info.java | 2 +-
.../interpol/ConfigurationInterpolator.java| 2 +-
.../commons/configuration2/interpol/Lookup.java| 2 +-
.../commons/configuration2/io/FileUtils.java | 10 +++
.../commons/configuration2/package-info.java | 6 ++--
.../tree/DefaultExpressionEngine.java | 2 +-
.../org/apache/commons/configuration2/Logging.java | 32 +++---
.../configuration2/TestINIConfiguration.java | 2 +-
.../beanutils/TestConfigurationDynaBean.java | 28 +--
.../builder/TestFileBasedConfigurationBuilder.java | 4 +--
...adingCombinedConfigurationBuilderFileBased.java | 2 +-
.../web/TestAppletConfiguration.java | 2 +-
17 files changed, 57 insertions(+), 57 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java
b/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java
index b3c4c9d..fb06e73 100644
--- a/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java
@@ -62,7 +62,7 @@ import org.apache.commons.lang3.ObjectUtils;
* A concrete sub class only needs to provide a generic {@code getProperty()}
* method.
* Support for variable interpolation. Property values containing special
- * variable tokens (like ${var}) will be replaced by their
+ * variable tokens (like {@code ${var}}) will be replaced by their
* corresponding values.
* Optional support for string lists. The values of properties to be added
to this
* configuration are checked whether they contain a list delimiter character.
If
@@ -1656,7 +1656,7 @@ public abstract class AbstractConfiguration extends
BaseEventSource implements C
* Returns a configuration with the same content as this configuration, but
* with all variables replaced by their actual values. This method tries to
* clone the configuration and then perform interpolation on all
properties.
- * So property values of the form ${var} will be resolved as
+ * So property values of the form {@code ${var}} will be resolved as
* far as possible (if a variable cannot be resolved, it remains
unchanged).
* This operation is useful if the content of a configuration is to be
* exported or processed by an external component that does not support
diff --git
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
index 4d8f4b7..1d4599f 100644
---
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
+++
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
@@ -68,7 +68,7 @@ import org.apache.commons.text.translate.UnicodeEscaper;
*
*
*
- * Each property has the syntax key value. The
+ * Each property has the syntax {@code key value}. The
* separators accepted are {@code '='}, {@code ':'} and any white
* space character. Examples:
*
@@ -770,8 +770,8 @@ public class PropertiesConfiguration extends
BaseConfiguration
* Reads a property line. Returns null if Stream is
* at EOF. Concatenates lines ending with "\".
* Skips lines beginning with "#" or "!" and empty lines.
- * The return value is a property definition (
- * = )
+ * The return value is a property definition ({@code }
+ * = {@code })
*
* @return A string containing a property value or null
*
diff --git
a/src/main/java/org/apache/commons/configuration2/PropertiesConfigurationLayout.java
b/src/main/java/org/apache/commons/configuration2/PropertiesConfigurationLayout.java
index 97f1630..3713d7a 100644
---
a/src/main/java/org/apache/commons/configuration2/PropertiesConfigurationLayout.java
+++
b/src/main/java/org/apache/commons/configuration2/PropertiesConfigurationLayout.java
@@ -104,8 +104,8 @@ import org.apache.commons.lang3.StringUt
