Package com.transifex.txnative.missingpolicy

Class WrappedStringPolicy

java.lang.Object

com.transifex.txnative.missingpolicy.WrappedStringPolicy

All Implemented Interfaces:

MissingPolicy

public class WrappedStringPolicy
extends Object
implements MissingPolicy

Wraps the source string with a custom format.

Example:

new WrappedStringPolicy(">>", "<<").get("Click here");

Returns:

">>Click here<<"

Constructor Summary

Constructors

Constructor	Description
WrappedStringPolicy(String start, String end)	Creates a new instance with the provided strings.

Method Summary

Modifier and Type	Method	Description
CharSequence	get(Resources resources, CharSequence sourceString, int id, String resourceName, String locale)	Returns a wrapped string.
CharSequence	getQuantityString(Resources resources, CharSequence sourceQuantityString, int id, int quantity, String resourceName, String locale)	Returns a wrapped quantity string.

Methods inherited from class java.lang.Object

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

Constructor Details

WrappedStringPolicy

public WrappedStringPolicy(@Nullable
 String start,
 @Nullable
 String end)

Creates a new instance with the provided strings.

Parameters:

start - The string to prepend the source String. Can be null.

end - The string to append to the source string. Can be null.

Method Details

get

@NonNull
public CharSequence get(@NonNull
 Resources resources,
 @NonNull
 CharSequence sourceString,
 @StringRes
 int id,
 @NonNull
 String resourceName,
 @NonNull
 String locale)

Returns a wrapped string.

Specified by:

get in interface MissingPolicy

Parameters:

resources - A Resources object. This is the base resources object returned by TxResources.getBaseResources().

sourceString - The source string.

id - The string resource identifier as defined by Resources.getIdentifier(String, String, String).

resourceName - The entry name of the string resource as defined by Resources.getResourceEntryName(int).

locale - The current locale as returned by LocaleState.getResolvedLocale().

Returns:

The translated string.

getQuantityString

@NonNull
public CharSequence getQuantityString(@NonNull
 Resources resources,
 @NonNull
 CharSequence sourceQuantityString,
 @PluralsRes
 int id,
 int quantity,
 @NonNull
 String resourceName,
 @NonNull
 String locale)

Returns a wrapped quantity string.

Specified by:

getQuantityString in interface MissingPolicy

Parameters:

resources - A Resources object. This is the base resources object returned by TxResources.getBaseResources().

sourceQuantityString - The source string having grammatically correct pluralization for the given quantity.

id - The plurals resource identifier as defined by Resources.getIdentifier(String, String, String).

quantity - The number used to get the correct string for the current language's plural rules.

resourceName - The entry name of the plurals resource as defined by Resources.getResourceEntryName(int).

locale - The current locale as returned by LocaleState.getResolvedLocale().

Returns:

The translated string.