com.phloc.commons.name

Interface IHasDisplayTextWithArgs

public interface IHasDisplayTextWithArgs

Base interface for objects that have a locale dependent display name.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayTextWithArgs(Locale aContentLocale, Object... aArgs)

Method Detail

getDisplayTextWithArgs

@Nullable
String getDisplayTextWithArgs(@Nonnull
                                     Locale aContentLocale,
                                     @Nullable
                                     Object... aArgs)

Parameters:

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

aArgs - Arguments for formatting the provided text. May be null but this makes no sense.

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.