Update Javadoc. Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/7733107d Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/7733107d Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/7733107d
Branch: refs/heads/release Commit: 7733107d1616d523bbe6137e5131496ee632eb8c Parents: 937d9da Author: Gary Gregory <garydgreg...@gmail.com> Authored: Fri Jun 1 15:55:45 2018 -0600 Committer: Gary Gregory <garydgreg...@gmail.com> Committed: Fri Jun 1 15:55:45 2018 -0600 ---------------------------------------------------------------------- .../commons/text/lookup/StringLookup.java | 124 +++++++++---------- 1 file changed, 62 insertions(+), 62 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-text/blob/7733107d/src/main/java/org/apache/commons/text/lookup/StringLookup.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/text/lookup/StringLookup.java b/src/main/java/org/apache/commons/text/lookup/StringLookup.java index f3098e7..2252729 100644 --- a/src/main/java/org/apache/commons/text/lookup/StringLookup.java +++ b/src/main/java/org/apache/commons/text/lookup/StringLookup.java @@ -1,62 +1,62 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache license, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the license for the specific language governing permissions and - * limitations under the license. - */ - -package org.apache.commons.text.lookup; - -/** - * Lookup a String key to a String value. - * <p> - * This class represents the simplest form of a string to string map. It has a benefit over a map in that it can create - * the result on demand based on the key. - * </p> - * <p> - * For example, it would be possible to implement a lookup that used the key as a primary key, and looked up the value - * on demand from the database - * </p> - * - * @since 1.3 - */ -public interface StringLookup { - - /** - * Looks up a String key to a String value. - * <p> - * The internal implementation may use any mechanism to return the value. The simplest implementation is to use a - * Map. However, virtually any implementation is possible. - * </p> - * <p> - * For example, it would be possible to implement a lookup that used the key as a primary key, and looked up the - * value on demand from the database Or, a numeric based implementation could be created that treats the key as an - * integer, increments the value and return the result as a string - converting 1 to 2, 15 to 16 etc. - * </p> - * <p> - * This method always returns a String, regardless of the underlying data, by converting it as necessary. For - * example: - * </p> - * - * <pre> - * Map<String, Object> map = new HashMap<String, Object>(); - * map.put("number", new Integer(2)); - * assertEquals("2", StrLookup.mapLookup(map).lookup("number")); - * </pre> - * - * @param key - * the key to look up, may be null - * @return the matching value, null if no match - */ - String lookup(String key); -} +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache license, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the license for the specific language governing permissions and + * limitations under the license. + */ + +package org.apache.commons.text.lookup; + +/** + * Lookup a String key to a String value. + * <p> + * This class represents the simplest form of a string to string map. It has a benefit over a map in that it can create + * the result on demand based on the key. + * </p> + * <p> + * For example, it would be possible to implement a lookup that used the key as a primary key, and looked up the value + * on demand from the database + * </p> + * + * @since 1.3 + */ +public interface StringLookup { + + /** + * Looks up a String key to a String value. + * <p> + * The internal implementation may use any mechanism to return the value. The simplest implementation is to use a + * Map. However, virtually any implementation is possible. + * </p> + * <p> + * For example, it would be possible to implement a lookup that used the key as a primary key, and looked up the + * value on demand from the database Or, a numeric based implementation could be created that treats the key as an + * integer, increments the value and return the result as a string - converting 1 to 2, 15 to 16 etc. + * </p> + * <p> + * This method always returns a String, regardless of the underlying data, by converting it as necessary. For + * example: + * </p> + * + * <pre> + * Map<String, Object> map = new HashMap<String, Object>(); + * map.put("number", new Integer(2)); + * assertEquals("2", StringLookupFactory.mapStringLookup(map).lookup("number")); + * </pre> + * + * @param key + * the key to look up, may be null + * @return the matching value, null if no match + */ + String lookup(String key); +}
