com.phloc.commons.text.impl

Class ConstantTextProvider

java.lang.Object

com.phloc.commons.text.impl.AbstractSimpleTextProvider

com.phloc.commons.text.impl.AbstractTextProvider

com.phloc.commons.text.impl.ConstantTextProvider

All Implemented Interfaces:

IHasDisplayName, IHasDisplayText, IHasName, ISimpleTextProvider, ITextProvider, Serializable

public class ConstantTextProvider
extends AbstractTextProvider
implements IHasDisplayText, IHasDisplayName, IHasName

An implementation of the ITextProvider interface that always returns a constant string. Use this only for texts that never need to be translated!
IHasDisplayText, IHasDisplayName and IHasName are only implemented, so that instances of this class can also be used as valid substitutes for these interfaces.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConstantTextProvider(String sFixedText)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDisplayName()
String	getDisplayText(Locale aContentLocale)
String	getName()
int	hashCode()
protected Locale	internalGetLocaleToUseWithFallback(Locale aContentLocale) Determine the locale to use.
protected String	internalGetText(Locale aContentLocale) Main text resolving
String	toString()

Methods inherited from class com.phloc.commons.text.impl.AbstractTextProvider

getTextWithArgs, getTextWithLocaleFallbackAndArgs

Methods inherited from class com.phloc.commons.text.impl.AbstractSimpleTextProvider

getText, getTextWithLocaleFallback

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.phloc.commons.text.ISimpleTextProvider

getText, getTextWithLocaleFallback

Constructor Detail

ConstantTextProvider

public ConstantTextProvider(@Nonnull
                    String sFixedText)

Method Detail

internalGetLocaleToUseWithFallback

protected Locale internalGetLocaleToUseWithFallback(@Nonnull
                                        Locale aContentLocale)

Description copied from class: AbstractSimpleTextProvider

Determine the locale to use.

Specified by:

internalGetLocaleToUseWithFallback in class AbstractSimpleTextProvider

Parameters:

aContentLocale - Requested locale

Returns:

The locale to use. May be null.

internalGetText

@Nullable
protected String internalGetText(@Nonnull
                              Locale aContentLocale)

Description copied from class: AbstractSimpleTextProvider

Main text resolving

Specified by:

internalGetText in class AbstractSimpleTextProvider

Parameters:

aContentLocale - locale to use

Returns:

null if no such text present in the passed locale

getDisplayText

@Nonnull
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.

getDisplayName

@Nonnull
public String getDisplayName()

Specified by:

getDisplayName in interface IHasDisplayName

Returns:

The display name of this object. Should never be null.

getName

@Nonnull
public String getName()

Specified by:

getName in interface IHasName

Returns:

The name of the object. May not be null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object