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-text.git
The following commit(s) were added to refs/heads/master by this push:
new ff23055f Javadoc
ff23055f is described below
commit ff23055f79609ba9c049446d051bc4f110a8722f
Author: Gary D. Gregory <[email protected]>
AuthorDate: Fri Aug 29 08:35:54 2025 -0400
Javadoc
---
.../java/org/apache/commons/text/lookup/BiFunctionStringLookup.java | 4 ++++
.../java/org/apache/commons/text/lookup/ConstantStringLookup.java | 4 ++++
src/main/java/org/apache/commons/text/lookup/DateStringLookup.java | 5 +++++
src/main/java/org/apache/commons/text/lookup/DnsStringLookup.java | 4 ++++
src/main/java/org/apache/commons/text/lookup/FileStringLookup.java | 4 ++++
.../java/org/apache/commons/text/lookup/FunctionStringLookup.java | 4 ++++
src/main/java/org/apache/commons/text/lookup/InetAddressKeys.java | 4 ++++
.../java/org/apache/commons/text/lookup/InetAddressStringLookup.java | 4 ++++
.../org/apache/commons/text/lookup/InterpolatorStringLookup.java | 5 +++++
.../org/apache/commons/text/lookup/JavaPlatformStringLookup.java | 4 ++++
.../java/org/apache/commons/text/lookup/PropertiesStringLookup.java | 4 ++++
.../org/apache/commons/text/lookup/ResourceBundleStringLookup.java | 4 ++++
src/main/java/org/apache/commons/text/lookup/ScriptStringLookup.java | 4 ++++
.../java/org/apache/commons/text/lookup/UrlDecoderStringLookup.java | 4 ++++
.../java/org/apache/commons/text/lookup/UrlEncoderStringLookup.java | 5 +++++
src/main/java/org/apache/commons/text/lookup/UrlStringLookup.java | 5 +++++
.../java/org/apache/commons/text/lookup/XmlDecoderStringLookup.java | 5 +++++
.../java/org/apache/commons/text/lookup/XmlEncoderStringLookup.java | 5 +++++
src/main/java/org/apache/commons/text/lookup/XmlStringLookup.java | 2 +-
19 files changed, 79 insertions(+), 1 deletion(-)
diff --git
a/src/main/java/org/apache/commons/text/lookup/BiFunctionStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/BiFunctionStringLookup.java
index 9e1891a5..336d4293 100644
--- a/src/main/java/org/apache/commons/text/lookup/BiFunctionStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/BiFunctionStringLookup.java
@@ -22,9 +22,13 @@ import java.util.function.BiFunction;
/**
* A function-based lookup where the request for a lookup is answered by
applying that function with a key.
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
*
* @param <R> A function's return type
* @param <P> A function's second input type
+ * @see StringLookupFactory
* @since 1.9
*/
final class BiFunctionStringLookup<P, R> implements BiStringLookup<P> {
diff --git
a/src/main/java/org/apache/commons/text/lookup/ConstantStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/ConstantStringLookup.java
index 1f70af9b..dff45098 100644
--- a/src/main/java/org/apache/commons/text/lookup/ConstantStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/ConstantStringLookup.java
@@ -58,7 +58,11 @@ import org.apache.commons.text.StringSubstitutor;
* <p>
* This class was adapted from Apache Commons Configuration.
* </p>
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
*
+ * @see StringLookupFactory
* @since 1.5
*/
class ConstantStringLookup extends AbstractStringLookup {
diff --git a/src/main/java/org/apache/commons/text/lookup/DateStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/DateStringLookup.java
index c684db35..fe313c2b 100644
--- a/src/main/java/org/apache/commons/text/lookup/DateStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/DateStringLookup.java
@@ -43,6 +43,11 @@ import org.apache.commons.text.StringSubstitutor;
* <p>
* The above examples convert {@code "yyyy-MM-dd"} to today's date, for
example, {@code "2019-08-04"}.
* </p>
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
+ *
+ * @see StringLookupFactory
*/
final class DateStringLookup extends AbstractStringLookup {
diff --git a/src/main/java/org/apache/commons/text/lookup/DnsStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/DnsStringLookup.java
index 0506b269..5d76eb93 100644
--- a/src/main/java/org/apache/commons/text/lookup/DnsStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/DnsStringLookup.java
@@ -53,7 +53,11 @@ import org.apache.commons.text.StringSubstitutor;
* <p>
* The above examples convert {@code "address|apache.org"} to {@code
"95.216.24.32} (or {@code "40.79.78.1"}).
* </p>
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
*
+ * @see StringLookupFactory
* @since 1.8
*/
final class DnsStringLookup extends AbstractStringLookup {
diff --git a/src/main/java/org/apache/commons/text/lookup/FileStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/FileStringLookup.java
index f8a957ea..bf36478a 100644
--- a/src/main/java/org/apache/commons/text/lookup/FileStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/FileStringLookup.java
@@ -45,7 +45,11 @@ import org.apache.commons.text.StringSubstitutor;
* <p>
* The above example converts {@code "UTF-8:SomePath"} to the UTF-8 contents
of the file at {@code SomePath}.
* </p>
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
*
+ * @see StringLookupFactory
* @since 1.5
*/
final class FileStringLookup extends AbstractPathFencedLookup {
diff --git
a/src/main/java/org/apache/commons/text/lookup/FunctionStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/FunctionStringLookup.java
index 4a7123ea..07df1489 100644
--- a/src/main/java/org/apache/commons/text/lookup/FunctionStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/FunctionStringLookup.java
@@ -22,8 +22,12 @@ import java.util.function.Function;
/**
* A function-based lookup where the request for a lookup is answered by
applying that function with a key.
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
*
* @param <V> A function's input type
+ * @see StringLookupFactory
* @since 1.9
*/
final class FunctionStringLookup<V> extends AbstractStringLookup {
diff --git a/src/main/java/org/apache/commons/text/lookup/InetAddressKeys.java
b/src/main/java/org/apache/commons/text/lookup/InetAddressKeys.java
index a188d4fd..e7eee013 100644
--- a/src/main/java/org/apache/commons/text/lookup/InetAddressKeys.java
+++ b/src/main/java/org/apache/commons/text/lookup/InetAddressKeys.java
@@ -21,7 +21,11 @@ import java.net.InetAddress;
/**
* Constants for referring to {@link InetAddress} APIs.
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
*
+ * @see StringLookupFactory
* @since 1.8
*/
final class InetAddressKeys {
diff --git
a/src/main/java/org/apache/commons/text/lookup/InetAddressStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/InetAddressStringLookup.java
index 346634cd..6d0183db 100644
--- a/src/main/java/org/apache/commons/text/lookup/InetAddressStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/InetAddressStringLookup.java
@@ -35,7 +35,11 @@ import org.apache.commons.lang3.function.FailableSupplier;
* <li><strong>canonical-name</strong>: for the local canonical host name, for
example {@code EXAMPLE.apache.org}.</li>
* <li><strong>address</strong>: for the local host address, for example
{@code 192.168.56.1}.</li>
* </ul>
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
*
+ * @see StringLookupFactory
* @since 1.3
*/
final class InetAddressStringLookup extends AbstractStringLookup {
diff --git
a/src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java
index c8646980..17e3da7b 100644
--- a/src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java
@@ -26,6 +26,11 @@ import java.util.stream.Collectors;
* <p>
* Uses the {@link StringLookupFactory default lookups}.
* </p>
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
+ *
+ * @see StringLookupFactory
*/
final class InterpolatorStringLookup extends AbstractStringLookup {
diff --git
a/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
index da1048bb..734e2dd4 100644
--- a/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
@@ -53,7 +53,11 @@ import org.apache.commons.text.StringSubstitutor;
* The above examples convert {@code "version"} to the current VM version, for
example,
* {@code "Java version 1.8.0_181"}.
* </p>
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
*
+ * @see StringLookupFactory
* @since 1.3
*/
final class JavaPlatformStringLookup extends AbstractStringLookup {
diff --git
a/src/main/java/org/apache/commons/text/lookup/PropertiesStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/PropertiesStringLookup.java
index d369ffcf..dab5f62d 100644
--- a/src/main/java/org/apache/commons/text/lookup/PropertiesStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/PropertiesStringLookup.java
@@ -35,7 +35,11 @@ import org.apache.commons.lang3.StringUtils;
* <p>
* For example: "com/domain/document.properties:key".
* </p>
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
*
+ * @see StringLookupFactory
* @see Properties
* @since 1.5
*/
diff --git
a/src/main/java/org/apache/commons/text/lookup/ResourceBundleStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/ResourceBundleStringLookup.java
index e92d131a..a517058e 100644
---
a/src/main/java/org/apache/commons/text/lookup/ResourceBundleStringLookup.java
+++
b/src/main/java/org/apache/commons/text/lookup/ResourceBundleStringLookup.java
@@ -28,7 +28,11 @@ import java.util.ResourceBundle;
* <p>
* For example: "com.domain.messages:MyKey".
* </p>
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
*
+ * @see StringLookupFactory
* @see ResourceBundle
* @since 1.3
*/
diff --git
a/src/main/java/org/apache/commons/text/lookup/ScriptStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/ScriptStringLookup.java
index 69721450..4151a732 100644
--- a/src/main/java/org/apache/commons/text/lookup/ScriptStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/ScriptStringLookup.java
@@ -39,7 +39,11 @@ import org.apache.commons.text.StringSubstitutor;
* <pre>
* StringSubstitutor.createInterpolator().replace("${script:javascript:3 +
4}"));
* </pre>
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
*
+ * @see StringLookupFactory
* @since 1.5
*/
final class ScriptStringLookup extends AbstractStringLookup {
diff --git
a/src/main/java/org/apache/commons/text/lookup/UrlDecoderStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/UrlDecoderStringLookup.java
index 8072d36c..0aabf06b 100644
--- a/src/main/java/org/apache/commons/text/lookup/UrlDecoderStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/UrlDecoderStringLookup.java
@@ -24,7 +24,11 @@ import java.nio.charset.StandardCharsets;
/**
* Decodes URL Strings using the UTF-8 encoding.
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
*
+ * @see StringLookupFactory
* @see URLEncoder
* @since 1.5
*/
diff --git
a/src/main/java/org/apache/commons/text/lookup/UrlEncoderStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/UrlEncoderStringLookup.java
index e34ecf46..15be8d75 100644
--- a/src/main/java/org/apache/commons/text/lookup/UrlEncoderStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/UrlEncoderStringLookup.java
@@ -24,6 +24,11 @@ import java.nio.charset.StandardCharsets;
/**
* Encodes URL Strings using the UTF-8 encoding.
*
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
+ *
+ * @see StringLookupFactory
* @see URLEncoder
* @since 1.5
*/
diff --git a/src/main/java/org/apache/commons/text/lookup/UrlStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/UrlStringLookup.java
index 00f431be..948f2b1b 100644
--- a/src/main/java/org/apache/commons/text/lookup/UrlStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/UrlStringLookup.java
@@ -33,6 +33,11 @@ import org.apache.commons.lang3.StringUtils;
* For example: "UTF-8:https://www.apache.org";.
* </p>
*
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
+ *
+ * @see StringLookupFactory
* @since 1.5
*/
final class UrlStringLookup extends AbstractStringLookup {
diff --git
a/src/main/java/org/apache/commons/text/lookup/XmlDecoderStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/XmlDecoderStringLookup.java
index 3176f33a..f3c4e93c 100644
--- a/src/main/java/org/apache/commons/text/lookup/XmlDecoderStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/XmlDecoderStringLookup.java
@@ -22,6 +22,11 @@ import org.apache.commons.text.StringEscapeUtils;
/**
* Decodes strings according to the XML 1.0 specification.
*
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
+ *
+ * @see StringLookupFactory
* @see StringEscapeUtils#unescapeXml(String)
*/
final class XmlDecoderStringLookup extends AbstractStringLookup {
diff --git
a/src/main/java/org/apache/commons/text/lookup/XmlEncoderStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/XmlEncoderStringLookup.java
index 50e6ffbc..b70cd20c 100644
--- a/src/main/java/org/apache/commons/text/lookup/XmlEncoderStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/XmlEncoderStringLookup.java
@@ -22,6 +22,11 @@ import org.apache.commons.text.StringEscapeUtils;
/**
* Encodes strings according to the XML 1.0 specification.
*
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
+ *
+ * @see StringLookupFactory
* @see StringEscapeUtils#escapeXml10(String)
* @since 1.11.0
*/
diff --git a/src/main/java/org/apache/commons/text/lookup/XmlStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/XmlStringLookup.java
index 0f3663fd..a476cc07 100644
--- a/src/main/java/org/apache/commons/text/lookup/XmlStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/XmlStringLookup.java
@@ -72,7 +72,7 @@ final class XmlStringLookup extends AbstractPathFencedLookup {
*/
XmlStringLookup(final Map<String, Boolean> xPathFactoryFeatures, final
Path... fences) {
super(fences);
- this.xPathFactoryFeatures =
Objects.requireNonNull(xPathFactoryFeatures, "xPathFactoryFeatures");
+ this.xPathFactoryFeatures =
Objects.requireNonNull(xPathFactoryFeatures, "xPathFfactoryFeatures");
}
/**
