com.helger.commons.text.display

Interface IHasDisplayText

All Superinterfaces:

Serializable

All Known Subinterfaces:

IHasDisplayTextWithArgs, IHasErrorText

All Known Implementing Classes:

ConstantHasDisplayText, ConstantHasErrorText, DynamicHasErrorText, DynamicHasErrorTextWithArgs, ECountry, ECountryName, ECountrySubName, ELocaleName, HasDisplayTextWithArgs

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface IHasDisplayText
extends Serializable

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

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default IHasText	getAsHasText()
static Comparator<IHasDisplayText>	getComparatorCollating(Locale aContentLocale, Locale aSortLocale)
String	getDisplayText(Locale aContentLocale)

Method Detail

getDisplayText

@Nullable
String getDisplayText(@Nonnull
                                 Locale aContentLocale)

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.

getAsHasText

@Nonnull
default IHasText getAsHasText()

Returns:

this as an instance of IHasText.

Since:

8.5.2

getComparatorCollating

@Nonnull
static Comparator<IHasDisplayText> getComparatorCollating(@Nonnull
                                                                    Locale aContentLocale,
                                                                    @Nullable
                                                                    Locale aSortLocale)