com.helger.commons.text

Class AbstractHasTextWithArgs

java.lang.Object

com.helger.commons.text.AbstractHasText

com.helger.commons.text.AbstractHasTextWithArgs

All Implemented Interfaces:

IHasText, IHasTextWithArgs

Direct Known Subclasses:

AbstractReadOnlyMapBasedMultilingualText, ConstantHasTextWithArgs, ResourceBundleTextProvider

public abstract class AbstractHasTextWithArgs
extends AbstractHasText
implements IHasTextWithArgs

An abstract implementation of the IHasTextWithArgs that has default implementations for the formatting things.

Author:

Philip Helger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHasTextWithArgs()

Method Summary

Modifier and Type	Method and Description
String	getTextWithArgs(Locale aContentLocale) Deprecated.
String	getTextWithArgs(Locale aContentLocale, Object... aArgs) Get the text specific for the passed locale.

Methods inherited from class com.helger.commons.text.AbstractHasText

getText, internalGetLocaleToUseWithFallback, internalGetText

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.text.IHasText

getText

Constructor Detail

AbstractHasTextWithArgs

protected AbstractHasTextWithArgs()

Method Detail

getTextWithArgs

@Nullable
 @Deprecated
 @DevelopersNote(value="Use getText instead!")
public String getTextWithArgs(@Nonnull
                                                                                                       Locale aContentLocale)

Deprecated.

Description copied from interface: IHasTextWithArgs

Get the text specific for the passed locale. The implementation class MAY add locale-generalisation when resolving the text ("de_DE" => "de" => default).

Specified by:

getTextWithArgs in interface IHasTextWithArgs

Parameters:

aContentLocale - The locale to use. May not be null.

Returns:

null if no text for the given locale was found.

getTextWithArgs

@Nullable
public final String getTextWithArgs(@Nonnull
                                               Locale aContentLocale,
                                               @Nullable
                                               Object... aArgs)

Description copied from interface: IHasTextWithArgs

Get the text specific for the passed locale. The implementation class MAY add locale-generalisation when resolving the text ("de_DE" => "de" => default). The placeholders will be resolved with the Format.format(Object) method.

Specified by:

getTextWithArgs in interface IHasTextWithArgs

Parameters:

aContentLocale - The locale to use. May not be null.

aArgs - The arguments to be added into the string. May be null but this makes no sense.

Returns:

null if no text for the given locale was found.