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 <garydgreg...@gmail.com>
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/commons/configuration2/MapConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/MapConfiguration.java
@@ -104,7 +104,7 @@ public class MapConfiguration extends AbstractConfiguration
implements Cloneable
}
/**
- * Return the Map decorated by this configuration.
+ * Gets the Map decorated by this configuration.
*
* @return the map this configuration is based onto
*/
diff --git
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
index 3084ae76..b49f4531 100644
---
a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
+++
b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
@@ -1295,7 +1295,7 @@ public class PropertiesConfiguration extends
BaseConfiguration implements FileBa
}
/**
- * Return the comment header.
+ * Gets the comment header.
*
* @return the comment header
* @since 1.1
diff --git
a/src/main/java/org/apache/commons/configuration2/SubsetConfiguration.java
b/src/main/java/org/apache/commons/configuration2/SubsetConfiguration.java
index 9db6d769..fd87053f 100644
--- a/src/main/java/org/apache/commons/configuration2/SubsetConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/SubsetConfiguration.java
@@ -73,7 +73,7 @@ public class SubsetConfiguration extends
AbstractConfiguration {
}
/**
- * Return the key in the parent configuration associated to the specified
key in this subset.
+ * Gets the key in the parent configuration associated to the specified
key in this subset.
*
* @param key The key in the subset.
* @return the key as to be used by the parent
@@ -86,7 +86,7 @@ public class SubsetConfiguration extends
AbstractConfiguration {
}
/**
- * Return the key in the subset configuration associated to the specified
key in the parent configuration.
+ * Gets the key in the subset configuration associated to the specified
key in the parent configuration.
*
* @param key The key in the parent configuration.
* @return the key in the context of this subset configuration
@@ -107,7 +107,7 @@ public class SubsetConfiguration extends
AbstractConfiguration {
}
/**
- * Return the parent configuration for this subset.
+ * Gets the parent configuration for this subset.
*
* @return the parent configuration
*/
@@ -116,7 +116,7 @@ public class SubsetConfiguration extends
AbstractConfiguration {
}
/**
- * Return the prefix used to select the properties in the parent
configuration.
+ * Gets the prefix used to select the properties in the parent
configuration.
*
* @return the prefix used by this subset
*/
diff --git
a/src/main/java/org/apache/commons/configuration2/io/FileHandler.java
b/src/main/java/org/apache/commons/configuration2/io/FileHandler.java
index c334353f..fa2af785 100644
--- a/src/main/java/org/apache/commons/configuration2/io/FileHandler.java
+++ b/src/main/java/org/apache/commons/configuration2/io/FileHandler.java
@@ -402,7 +402,7 @@ public class FileHandler {
}
/**
- * Return the base path. If no base path is defined, but a URL, the base
path is derived from there.
+ * Gets the base path. If no base path is defined, but a URL, the base
path is derived from there.
*
* @return the base path
*/
@@ -461,7 +461,7 @@ public class FileHandler {
}
/**
- * Return the name of the file. If only a URL is defined, the file name is
derived from there.
+ * Gets the name of the file. If only a URL is defined, the file name is
derived from there.
*
* @return the file name
*/
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 6f0978ad..f40a79ee 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
https://xyz.net/foo/bar.xml results in https://xyz.net/foo/
+ * Gets 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/resolver/EntityResolverSupport.java
b/src/main/java/org/apache/commons/configuration2/resolver/EntityResolverSupport.java
index 2bd1c0e1..5d12b881 100644
---
a/src/main/java/org/apache/commons/configuration2/resolver/EntityResolverSupport.java
+++
b/src/main/java/org/apache/commons/configuration2/resolver/EntityResolverSupport.java
@@ -25,7 +25,7 @@ import org.xml.sax.EntityResolver;
*/
public interface EntityResolverSupport {
/**
- * Return the EntityResolver associated with the class.
+ * Gets the EntityResolver associated with the class.
*
* @return The EntityResolver.
*/
diff --git
a/src/test/java/org/apache/commons/configuration2/TestAbstractConfiguration.java
b/src/test/java/org/apache/commons/configuration2/TestAbstractConfiguration.java
index 4522af21..b3e3ba24 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 {
/**
- * Return an abstract configuration with the following data:<br>
+ * Gets an abstract configuration with the following data:<br>
*
* <pre>
* key1 = value1
@@ -55,7 +55,7 @@ public abstract class TestAbstractConfiguration {
protected abstract AbstractConfiguration getConfiguration();
/**
- * Return an empty configuration.
+ * Gets an empty configuration.
*/
protected abstract AbstractConfiguration getEmptyConfiguration();
