Class ResourceBundleStringLookup

java.lang.Object

org.apache.commons.text.lookup.AbstractStringLookup

org.apache.commons.text.lookup.ResourceBundleStringLookup

All Implemented Interfaces:

Function<String,String>, UnaryOperator<String>, StringLookup

final class ResourceBundleStringLookup
extends AbstractStringLookup

Looks up keys from resource bundles.

Looks up the value for a given key in the format "BundleName:BundleKey".

For example: "com.domain.messages:MyKey".

Public access is through StringLookupFactory.

Since:

1.3

See Also:

• StringLookupFactory
• ResourceBundle

Field Summary

Fields

Modifier and Type	Field	Description
private final String	bundleName	The name of the resource bundle from which to look something up.
(package private) static final ResourceBundleStringLookup	INSTANCE	Defines the singleton for this class.

Fields inherited from class AbstractStringLookup

SPLIT_CH, SPLIT_STR

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ResourceBundleStringLookup()	Constructs a blank instance.
(package private)	ResourceBundleStringLookup(String bundleName)	Constructs an instance that only works for the given bundle.

Method Summary

Modifier and Type	Method	Description
(package private) ResourceBundle	getBundle(String keyBundleName)
(package private) String	getString(String keyBundleName, String bundleKey)
String	lookup(String key)	Looks up the value for the key in the format "BundleName:BundleKey".
String	toString()

Methods inherited from class AbstractStringLookup

substringAfter, substringAfter, substringAfterLast, toLookupKey, toLookupKey

Methods inherited from class Object

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

Methods inherited from interface Function

andThen, compose

Methods inherited from interface StringLookup

apply

Field Details

INSTANCE

static final ResourceBundleStringLookup INSTANCE

Defines the singleton for this class.

bundleName

private final String bundleName

The name of the resource bundle from which to look something up.

Constructor Details

ResourceBundleStringLookup

private ResourceBundleStringLookup()

Constructs a blank instance.

ResourceBundleStringLookup

ResourceBundleStringLookup(String bundleName)

Constructs an instance that only works for the given bundle.

Parameters:

bundleName - the name of the resource bundle from which we will look keys up.

Since:

1.5

Method Details

getBundle

ResourceBundle getBundle(String keyBundleName)

getString

String getString(String keyBundleName,
 String bundleKey)

lookup

public String lookup(String key)

Looks up the value for the key in the format "BundleName:BundleKey". For example: "com.domain.messages:MyKey".

Parameters:

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

Returns:

The value associated with the key.

See Also:

• ResourceBundle
• ResourceBundle.getBundle(String)
• ResourceBundle.getString(String)

toString

public String toString()

Overrides:

toString in class Object