Javadoc

Author: garydgregory

src/main/java/org/apache/commons/text/lookup/BiFunctionStringLookup.java

@@ -22,9 +22,13 @@
 
 /**
  * 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> {

src/main/java/org/apache/commons/text/lookup/ConstantStringLookup.java

@@ -58,7 +58,11 @@
  * <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 {

src/main/java/org/apache/commons/text/lookup/DateStringLookup.java

@@ -43,6 +43,11 @@
  * <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 {
 

src/main/java/org/apache/commons/text/lookup/DnsStringLookup.java

@@ -53,7 +53,11 @@
  * <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 {

src/main/java/org/apache/commons/text/lookup/FileStringLookup.java

@@ -45,7 +45,11 @@
  * <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 {

src/main/java/org/apache/commons/text/lookup/FunctionStringLookup.java

@@ -22,8 +22,12 @@
 
 /**
  * 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 {

src/main/java/org/apache/commons/text/lookup/InetAddressKeys.java

@@ -21,7 +21,11 @@
 
 /**
  * Constants for referring to {@link InetAddress} APIs.
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
  *
+ * @see StringLookupFactory
  * @since 1.8
  */
 final class InetAddressKeys {

src/main/java/org/apache/commons/text/lookup/InetAddressStringLookup.java

@@ -35,7 +35,11 @@
  * <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 {

src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java

@@ -26,6 +26,11 @@
  * <p>
  * Uses the {@link StringLookupFactory default lookups}.
  * </p>
+ * <p>
+ * Public access is through {@link StringLookupFactory}.
+ * </p>
+ *
+ * @see StringLookupFactory
  */
 final class InterpolatorStringLookup extends AbstractStringLookup {
 

src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java

@@ -53,7 +53,11 @@
  * 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 {