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 4800e57 Expand Javadoc for DefaultStringLookup. 4800e57 is described below commit 4800e5712abd4033b01a09f99162d3bf5b18e30d Author: Gary Gregory <gardgreg...@gmail.com> AuthorDate: Sun Aug 4 11:39:16 2019 -0400 Expand Javadoc for DefaultStringLookup. --- .../commons/text/lookup/DefaultStringLookup.java | 42 +++++++++++----------- 1 file changed, 20 insertions(+), 22 deletions(-) diff --git a/src/main/java/org/apache/commons/text/lookup/DefaultStringLookup.java b/src/main/java/org/apache/commons/text/lookup/DefaultStringLookup.java index c9632fa..6f75937 100644 --- a/src/main/java/org/apache/commons/text/lookup/DefaultStringLookup.java +++ b/src/main/java/org/apache/commons/text/lookup/DefaultStringLookup.java @@ -19,7 +19,7 @@ package org.apache.commons.text.lookup; /** * An enumeration defining {@link StringLookup} objects available through {@link StringLookupFactory}. * <p> - * This enum was adapted from Apache Commons Configuration 2.4-SNAPSHOT. + * This enum was adapted and expanded from Apache Commons Configuration 2.4. * </p> * * @see StringLookupFactory @@ -29,89 +29,89 @@ package org.apache.commons.text.lookup; public enum DefaultStringLookup { /** - * The lookup for Base64 decoding. + * The lookup for Base64 decoding using the key {@value StringLookupFactory#KEY_BASE64_DECODER}. */ BASE64_DECODER(StringLookupFactory.KEY_BASE64_DECODER, StringLookupFactory.INSTANCE.base64DecoderStringLookup()), /** - * The lookup for Base64 decoding. + * The lookup for Base64 decoding using the key {@value StringLookupFactory#KEY_BASE64_ENCODER}. */ BASE64_ENCODER(StringLookupFactory.KEY_BASE64_ENCODER, StringLookupFactory.INSTANCE.base64EncoderStringLookup()), /** - * The lookup for constants. + * The lookup for constants using the key {@value StringLookupFactory#KEY_CONST}. */ CONST(StringLookupFactory.KEY_CONST, StringLookupFactory.INSTANCE.constantStringLookup()), /** - * The lookup for dates. + * The lookup for dates using the key {@value StringLookupFactory#KEY_DATE}. */ DATE(StringLookupFactory.KEY_DATE, StringLookupFactory.INSTANCE.dateStringLookup()), /** - * The lookup for DNS. + * The lookup for DNS using the key {@value StringLookupFactory#KEY_DNS}. * * @since 1.8 */ DNS(StringLookupFactory.KEY_DNS, StringLookupFactory.INSTANCE.dnsStringLookup()), /** - * The lookup for environment properties. + * The lookup for environment properties using the key {@value StringLookupFactory#KEY_ENV}. */ ENVIRONMENT(StringLookupFactory.KEY_ENV, StringLookupFactory.INSTANCE.environmentVariableStringLookup()), /** - * The lookup for files. + * The lookup for files using the key {@value StringLookupFactory#KEY_FILE}. */ FILE(StringLookupFactory.KEY_FILE, StringLookupFactory.INSTANCE.fileStringLookup()), /** - * The lookup for Java platform information. + * The lookup for Java platform information using the key {@value StringLookupFactory#KEY_JAVA}. */ JAVA(StringLookupFactory.KEY_JAVA, StringLookupFactory.INSTANCE.javaPlatformStringLookup()), /** - * The lookup for localhost information. + * The lookup for localhost information using the key {@value StringLookupFactory#KEY_LOCALHOST}. */ LOCAL_HOST(StringLookupFactory.KEY_LOCALHOST, StringLookupFactory.INSTANCE.localHostStringLookup()), /** - * The lookup for properties. + * The lookup for properties using the key {@value StringLookupFactory#KEY_PROPERTIES}. */ PROPERTIES(StringLookupFactory.KEY_PROPERTIES, StringLookupFactory.INSTANCE.propertiesStringLookup()), /** - * The lookup for resource bundles. + * The lookup for resource bundles using the key {@value StringLookupFactory#KEY_RESOURCE_BUNDLE}. */ RESOURCE_BUNDLE(StringLookupFactory.KEY_RESOURCE_BUNDLE, StringLookupFactory.INSTANCE.resourceBundleStringLookup()), /** - * The lookup for scripts. + * The lookup for scripts using the key {@value StringLookupFactory#KEY_SCRIPT}. */ SCRIPT(StringLookupFactory.KEY_SCRIPT, StringLookupFactory.INSTANCE.scriptStringLookup()), /** - * The lookup for system properties. + * The lookup for system properties using the key {@value StringLookupFactory#KEY_SYS}. */ SYSTEM_PROPERTIES(StringLookupFactory.KEY_SYS, StringLookupFactory.INSTANCE.systemPropertyStringLookup()), /** - * The lookup for URLs. + * The lookup for URLs using the key {@value StringLookupFactory#KEY_URL}. */ URL(StringLookupFactory.KEY_URL, StringLookupFactory.INSTANCE.urlStringLookup()), /** - * The lookup for URL decoding. + * The lookup for URL decoding using the key {@value StringLookupFactory#KEY_URL_DECODER}. */ URL_DECODER(StringLookupFactory.KEY_URL_DECODER, StringLookupFactory.INSTANCE.urlDecoderStringLookup()), /** - * The lookup for URL decoding. + * The lookup for URL decoding using the key {@value StringLookupFactory#KEY_URL_ENCODER}. */ URL_ENCODER(StringLookupFactory.KEY_URL_ENCODER, StringLookupFactory.INSTANCE.urlEncoderStringLookup()), /** - * The lookup for URL decoding. + * The lookup for URL decoding using the key {@value StringLookupFactory#KEY_XML}. */ XML(StringLookupFactory.KEY_XML, StringLookupFactory.INSTANCE.xmlStringLookup()); @@ -124,10 +124,8 @@ public enum DefaultStringLookup { /** * Creates a new instance of {@link DefaultStringLookup} and sets the key and the associated lookup instance. * - * @param prefix - * the prefix - * @param lookup - * the {@link StringLookup} instance + * @param prefix the prefix + * @param lookup the {@link StringLookup} instance */ DefaultStringLookup(final String prefix, final StringLookup lookup) { this.key = prefix;