com.helger.commons.text

Class HasTextWithArgs

java.lang.Object

com.helger.commons.text.HasTextWithArgs

All Implemented Interfaces:

IHasText, Serializable

@Immutable
public class HasTextWithArgs
extends Object
implements IHasText

A special implementation of IHasText that encapsulates arguments to be put into the message.

Since:

8.5.2

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HasTextWithArgs(IHasText aParentText, Object... aArgs)

Method Summary

Modifier and Type	Method and Description
Object[]	getAllArgs() Get all arguments from the constructor.
IHasText	getParentText()
String	getText(Locale aContentLocale) Get the text specific for the passed locale.
String	toString()

Methods inherited from class java.lang.Object

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

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

getAsHasDisplayText, getComparatorCollating

Constructor Detail

HasTextWithArgs

public HasTextWithArgs(@Nonnull
                       IHasText aParentText,
                       @Nonnull @Nonempty
                       Object... aArgs)

Method Detail

getParentText

@Nonnull
public IHasText getParentText()

getAllArgs

@Nonnull
 @Nonempty
 @ReturnsMutableCopy
public Object[] getAllArgs()

Get all arguments from the constructor.

Returns:

a copy of all arguments. Neither null nor empty-

getText

@Nullable
public String getText(@Nonnull
                                 Locale aContentLocale)

Description copied from interface: IHasText

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:

getText in interface IHasText

Parameters:

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

Returns:

null if no text for the given locale was found.

toString

public String toString()

Overrides:

toString in class Object