Package com.plotsquared.core.configuration.caption

Class PerUserLocaleCaptionMap

java.lang.Object

com.plotsquared.core.configuration.caption.LocalizedCaptionMap

com.plotsquared.core.configuration.caption.PerUserLocaleCaptionMap

All Implemented Interfaces:

CaptionMap

public class PerUserLocaleCaptionMap
extends LocalizedCaptionMap

Nested Class Summary

Nested classes/interfaces inherited from interface com.plotsquared.core.configuration.caption.CaptionMap

CaptionMap.NoSuchCaptionException

Constructor Summary

Constructors

Constructor	Description
PerUserLocaleCaptionMap(Map<Locale,CaptionMap> localeMap)

Method Summary

Modifier and Type	Method	Description
@NonNull Set<TranslatableCaption>	getCaptions()	Gets a copy of the set of captions stored in the CaptionMap
@NonNull String	getMessage(@NonNull TranslatableCaption caption, @NonNull LocaleHolder localeHolder)	Get a message using a specific locale
boolean	supportsLocale(@NonNull Locale locale)	Check if the map supports a given locale

Methods inherited from class com.plotsquared.core.configuration.caption.LocalizedCaptionMap

getLocale, getMessage

Methods inherited from class java.lang.Object

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

Constructor Details

PerUserLocaleCaptionMap

public PerUserLocaleCaptionMap(Map<Locale,CaptionMap> localeMap)

Method Details

getMessage

public @NonNull String getMessage(@NonNull TranslatableCaption caption,
 @NonNull LocaleHolder localeHolder)
                           throws CaptionMap.NoSuchCaptionException

Description copied from interface: CaptionMap

Get a message using a specific locale

Specified by:

getMessage in interface CaptionMap

Overrides:

getMessage in class LocalizedCaptionMap

Parameters:

caption - Caption containing the caption key

localeHolder - Holder that determines the message locale

Returns:

Component

Throws:

CaptionMap.NoSuchCaptionException - if no caption with the given key exists

supportsLocale

public boolean supportsLocale(@NonNull Locale locale)

Description copied from interface: CaptionMap

Check if the map supports a given locale

Specified by:

supportsLocale in interface CaptionMap

Overrides:

supportsLocale in class LocalizedCaptionMap

Parameters:

locale - Locale

Returns:

True if the map supports the locale

getCaptions

public @NonNull Set<TranslatableCaption> getCaptions()

Description copied from interface: CaptionMap

Gets a copy of the set of captions stored in the CaptionMap

Specified by:

getCaptions in interface CaptionMap

Overrides:

getCaptions in class LocalizedCaptionMap

Returns:

An immutable set of TranslatableCaption