Repository: commons-text Updated Branches: refs/heads/master 6872117ae -> 561354228
(fix) checkstyle nits...javadocs Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/56135422 Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/56135422 Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/56135422 Branch: refs/heads/master Commit: 5613542285d25c7ab75555f77a39741605aee061 Parents: 6872117 Author: Rob Tompkins <chtom...@apache.org> Authored: Fri Sep 28 13:05:16 2018 -0400 Committer: Rob Tompkins <chtom...@apache.org> Committed: Fri Sep 28 13:05:16 2018 -0400 ---------------------------------------------------------------------- .../java/org/apache/commons/text/StringSubstitutor.java | 3 ++- .../commons/text/lookup/JavaPlatformStringLookup.java | 11 +++++++++++ .../commons/text/lookup/ResourceBundleStringLookup.java | 4 ++++ 3 files changed, 17 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-text/blob/56135422/src/main/java/org/apache/commons/text/StringSubstitutor.java ---------------------------------------------------------------------- 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 @@ public class StringSubstitutor { /** * 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); // ----------------------------------------------------------------------- /** http://git-wip-us.apache.org/repos/asf/commons-text/blob/56135422/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java ---------------------------------------------------------------------- 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 @@ import org.apache.commons.lang3.StringUtils; */ 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 @@ final class JavaPlatformStringLookup extends AbstractStringLookup { */ 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)); http://git-wip-us.apache.org/repos/asf/commons-text/blob/56135422/src/main/java/org/apache/commons/text/lookup/ResourceBundleStringLookup.java ---------------------------------------------------------------------- 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 @@ import java.util.ResourceBundle; */ 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 @@ final class ResourceBundleStringLookup extends AbstractStringLookup { /** * 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) {