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 0886a461f Javadoc
0886a461f is described below
commit 0886a461f6a0052d4d516401369eae2069564f87
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Feb 1 07:45:20 2026 -0500
Javadoc
---
.../commons/configuration2/DataConfiguration.java | 20 ++++----
.../configuration2/ImmutableConfiguration.java | 55 +++++++++++++++-------
.../configuration2/TestAbstractConfiguration.java | 2 +-
3 files changed, 50 insertions(+), 27 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/DataConfiguration.java
b/src/main/java/org/apache/commons/configuration2/DataConfiguration.java
index b155962df..abe2756ae 100644
--- a/src/main/java/org/apache/commons/configuration2/DataConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/DataConfiguration.java
@@ -51,27 +51,29 @@ import org.apache.commons.lang3.StringUtils;
* <li>{@code jakarta.mail.internet.InternetAddress} (requires Javamail 2.+ in
the classpath)</li>
* <li>{@link Enum}</li>
* </ul>
- *
- * Lists and arrays are available for all types.<br>
+ * <p>
+ * Lists and arrays are available for all types.
+ * </p>
+ * <p>
* Note that this class is only a thin wrapper over functionality already
provided by {@link AbstractConfiguration}.
* Basically, the generic {@code get()}, and {@code getCollection()} methods
are used to actually perform data
* conversions.
- *
+ * </p>
* <p>
* <strong>Example</strong>
* </p>
- *
+ * <p>
* Configuration file {@code config.properties}:
- *
+ * </p>
* <pre>
* title.color = #0000FF
* remote.host = 192.168.0.53
* default.locales = fr,en,de
* email.contact = [email protected], [email protected]
* </pre>
- *
+ * <p>
* Usage:
- *
+ * </p>
* <pre>
* DataConfiguration config = new DataConfiguration(new
PropertiesConfiguration("config.properties"));
*
@@ -87,12 +89,12 @@ import org.apache.commons.lang3.StringUtils;
* <p>
* <strong>Dates</strong>
* </p>
- *
+ * <p>
* Date objects are expected to be formatted with the pattern {@code
yyyy-MM-dd HH:mm:ss}. This default format can be
* changed by specifying another format in the getters, or by putting a date
format in the configuration under the key
* {@code org.apache.commons.configuration.format.date}. Alternatively, the
date format can also be specified via the
* {@code ConversionHandler} used by a configuration instance:
- *
+ * </p>
* <pre>
* DefaultConversionHandler handler = new DefaultConversionHandler();
* handler.setDateFormat("mm/dd/yyyy");
diff --git
a/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
b/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
index 24eeec72d..fb4ab41f9 100644
---
a/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
+++
b/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
@@ -555,14 +555,24 @@ public interface ImmutableConfiguration {
Iterator<String> getKeys();
/**
- * Gets the list of the keys contained in the configuration that match the
specified prefix. For instance, if the
- * configuration contains the following keys:<br>
- * {@code db.user, db.pwd, db.url, window.xpos, window.ypos},<br>
- * an invocation of {@code getKeys("db");}<br>
- * will return the keys below:<br>
- * {@code db.user, db.pwd, db.url}.<br>
- * Note that the prefix itself is included in the result set if there is a
matching key. The exact behavior - how the
- * prefix is actually interpreted - depends on a concrete implementation.
+ * Gets the list of the keys contained in the configuration that match the
specified prefix.
+ * <p>
+ * For instance, if the configuration contains the following keys:
+ * </p>
+ * <pre>
+ * db.user, db.pwd, db.url, window.xpos, window.ypos
+ * </pre>
+ * <p>
+ * The expression {@code getKeys("db")} will return:
+ * </p>
+ *
+ * <pre>
+ * db.user, db.pwd, db.url
+ * </pre>
+ * <p>
+ * Note that the prefix itself is included in the result set if there is a
matching key. The exact behavior - how the prefix is actually interpreted -
+ * depends on a concrete implementation.
+ * </p>
*
* @param prefix The prefix to test against.
* @return An Iterator of keys that match the prefix.
@@ -571,16 +581,27 @@ public interface ImmutableConfiguration {
Iterator<String> getKeys(String prefix);
/**
- * Gets the list of the keys contained in the configuration that match the
specified prefix. For instance, if the
- * configuration contains the following keys:<br>
- * {@code db@user, db@pwd, db@url, window.xpos, window.ypos},<br>
- * an invocation of {@code getKeys("db","@");}<br>
- * will return the keys below:<br>
- * {@code db@user, db@pwd, db@url}.<br>
- * Note that the prefix itself is included in the result set if there is a
matching key. The exact behavior - how the
- * prefix is actually interpreted - depends on a concrete implementation.
+ * Gets the list of the keys contained in the configuration that match the
specified prefix.
+ * <p>
+ * For instance, if the configuration contains the following keys:
+ * </p>
*
- * @param prefix The prefix to test against.
+ * <pre>
+ * db@user, db@pwd, db@url, window.xpos, window.ypos
+ * </pre>
+ * <p>
+ * The expression {@code getKeys("db","@")} will return:
+ * </p>
+ *
+ * <pre>
+ * db@user, db@pwd, db@url
+ * </pre>
+ * <p>
+ * Note that the prefix itself is included in the result set if there is a
matching key. The exact behavior - how the prefix is actually interpreted -
+ * depends on a concrete implementation.
+ * </p>
+ *
+ * @param prefix The prefix to test against.
* @param delimiter The prefix delimiter.
* @return An Iterator of keys that match the prefix.
* @see #getKeys()
diff --git
a/src/test/java/org/apache/commons/configuration2/TestAbstractConfiguration.java
b/src/test/java/org/apache/commons/configuration2/TestAbstractConfiguration.java
index 81335ec38..8005d9880 100644
---
a/src/test/java/org/apache/commons/configuration2/TestAbstractConfiguration.java
+++
b/src/test/java/org/apache/commons/configuration2/TestAbstractConfiguration.java
@@ -43,7 +43,7 @@ import org.junit.jupiter.api.Test;
public abstract class TestAbstractConfiguration {
/**
- * Gets an abstract configuration with the following data:<br>
+ * Gets an abstract configuration with the following data:
*
* <pre>
* key1 = value1
