Package org.apache.commons.text.lookup

Class UrlEncoderStringLookup

java.lang.Object

org.apache.commons.text.lookup.AbstractStringLookup

org.apache.commons.text.lookup.UrlEncoderStringLookup

All Implemented Interfaces:

StringLookup

final class UrlEncoderStringLookup
extends AbstractStringLookup

Encodes URL Strings using the UTF-8 encoding.

Since:

1.5

See Also:

URLEncoder

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static UrlEncoderStringLookup	INSTANCE	Defines the singleton for this class.

Fields inherited from class org.apache.commons.text.lookup.AbstractStringLookup

SPLIT_CH, SPLIT_STR

Constructor Summary

Constructors

Constructor	Description
UrlEncoderStringLookup()	This ctor is not private to allow Mockito spying.

Method Summary

Modifier and Type	Method	Description
(package private) String	encode(String key, String enc)
String	lookup(String key)	Looks up a String key to provide a String value.

Methods inherited from class org.apache.commons.text.lookup.AbstractStringLookup

substringAfter, substringAfter, substringAfterLast, toLookupKey, toLookupKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

static final UrlEncoderStringLookup INSTANCE

Defines the singleton for this class.

Constructor Detail

UrlEncoderStringLookup

UrlEncoderStringLookup()

This ctor is not private to allow Mockito spying.

Method Detail

encode

String encode(String key,
              String enc)
       throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

lookup

public String lookup(String key)

Description copied from interface: StringLookup

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", new Integer(2));
 assertEquals("2", StringLookupFactory.mapStringLookup(map).lookup("number"));
 

Parameters:

key - the key to look up, may be null.

Returns:

The matching value, null if no match.