Top Description Methods
org.apache.commons.text.lookup

public Interface StringLookup

extends UnaryOperator<String>
Known Direct Subinterfaces
org.apache.commons.text.lookup.BiStringLookup
Known Direct Implementers
org.apache.commons.text.StrLookup, org.apache.commons.text.lookup.AbstractStringLookup
Annotations
@FunctionalInterface
Imports
java.util.function.UnaryOperator

Lookups a String key for a String value.

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.

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.

Since
1.3

Method Summary

Modifier and TypeMethod and Description
public default String

Returns:

The matching value, null if no match.
apply
(final String
the key to look up, may be null.
key
)

Implements java.util.function.Function.apply.

Looks up a String key to provide a String value.

public String

Returns:

The matching value, null if no match.
lookup
(String
the key to look up, may be null.
key
)
Deprecated Use apply(String).

Looks up a String key to provide a String value.

Inherited from java.util.function.UnaryOperator:
identity

Method Detail

applyback to summary
public default String apply(final String key)

Implements java.util.function.Function.apply.

Looks up a String key to provide a String value.

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.

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.

This method always returns a String, regardless of the underlying data, by converting it as necessary. For example:

Map<String, Object> map = new HashMap<String, Object>();
map.put("number", Integer.valueOf(2));
assertEquals("2", StringLookupFactory.mapStringLookup(map).lookup("number"));
Parameters
key:String

the key to look up, may be null.

Returns:String

The matching value, null if no match.

Annotations
@Override
Since
1.14.0
lookupback to summary
public String lookup(String key)

Deprecated

Use apply(String).

Looks up a String key to provide a String value.

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.

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.

This method always returns a String, regardless of the underlying data, by converting it as necessary. For example:

Map<String, Object> map = new HashMap<String, Object>();
map.put("number", Integer.valueOf(2));
assertEquals("2", StringLookupFactory.mapStringLookup(map).lookup("number"));
Parameters
key:String

the key to look up, may be null.

Returns:String

The matching value, null if no match.

Annotations
@Deprecated