com.helger.commons.text.display

Class HasDisplayTextWithArgs

java.lang.Object

com.helger.commons.text.display.HasDisplayTextWithArgs

All Implemented Interfaces:

IHasDisplayText, Serializable

@Immutable
public class HasDisplayTextWithArgs
extends Object
implements IHasDisplayText

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

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HasDisplayTextWithArgs(IHasDisplayText aParentText, Object... aArgs)

Method Summary

Modifier and Type	Method and Description
Object[]	getAllArgs() Get all arguments from the constructor.
String	getDisplayText(Locale aContentLocale)
IHasDisplayText	getParentText()
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.display.IHasDisplayText

getAsHasText, getComparatorCollating

Constructor Detail

HasDisplayTextWithArgs

public HasDisplayTextWithArgs(@Nonnull
                              IHasDisplayText aParentText,
                              @Nonnull @Nonempty
                              Object... aArgs)

Method Detail

getParentText

@Nonnull
public IHasDisplayText getParentText()

getAllArgs

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

Get all arguments from the constructor.

Returns:

a copy of all arguments. Neither null nor empty-

getDisplayText

@Nullable
public String getDisplayText(@Nonnull
                                        Locale aContentLocale)

Specified by:

getDisplayText in interface IHasDisplayText

Parameters:

aContentLocale - The locale to be used for resolving. May not be null.

Returns:

The display text of the object in the given locale. May be null if the text could not be resolved in the passed locale.

toString

public String toString()

Overrides:

toString in class Object