(fix) checkstyle nits...javadocs
diff --git a/src/main/java/org/apache/commons/text/StringSubstitutor.java b/src/main/java/org/apache/commons/text/StringSubstitutor.java
index 58f6e82..fbebd61 100644
--- a/src/main/java/org/apache/commons/text/StringSubstitutor.java
+++ b/src/main/java/org/apache/commons/text/StringSubstitutor.java
@@ -173,7 +173,8 @@
/**
* Constant for the default value delimiter of a variable.
*/
- public static final StringMatcher DEFAULT_VALUE_DELIMITER = StringMatcherFactory.INSTANCE.stringMatcher(DEFAULT_VAR_DEFAULT);
+ public static final StringMatcher DEFAULT_VALUE_DELIMITER =
+ StringMatcherFactory.INSTANCE.stringMatcher(DEFAULT_VAR_DEFAULT);
// -----------------------------------------------------------------------
/**
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 383c10a..81ad40a 100644
--- a/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
@@ -38,11 +38,17 @@
*/
final class JavaPlatformStringLookup extends AbstractStringLookup {
+ /** <code>locale</code> key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_LOCALE = "locale";
+ /** <code>hardware</code> key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_HARDWARE = "hardware";
+ /** <code>os</code> key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_OS = "os";
+ /** <code>vm</code> key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_VM = "vm";
+ /** <code>runtime</code> key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_RUNTIME = "runtime";
+ /** <code>version</code> key for driving {@link JavaPlatformStringLookup#lookup(String)}. */
private static final String KEY_VERSION = "version";
/**
@@ -50,6 +56,11 @@
*/
static final JavaPlatformStringLookup INSTANCE = new JavaPlatformStringLookup();
+ /**
+ * The main method for running the JavaPlatformStringLookup.
+ *
+ * @param args the standard java main method parameter which is unused for our running of this class.
+ */
public static void main(String[] args) {
System.out.println(JavaPlatformStringLookup.class);
System.out.printf("%s = %s\n", KEY_VERSION, JavaPlatformStringLookup.INSTANCE.lookup(KEY_VERSION));
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 8a14c1b..876de18 100644
--- a/src/main/java/org/apache/commons/text/lookup/ResourceBundleStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/ResourceBundleStringLookup.java
@@ -33,6 +33,9 @@
*/
final class ResourceBundleStringLookup extends AbstractStringLookup {
+ /**
+ * The name of the resource bundle from which to look something up.
+ */
private final String bundleName;
/**
@@ -50,6 +53,7 @@
/**
* Constructs an instance that only works for the given bundle.
*
+ * @param bundleName the name of the resource bundle from which we will look keys up.
* @since 1.5
*/
ResourceBundleStringLookup(final String bundleName) {
