Package com.plotsquared.core.configuration.caption

Class DummyCaptionMap

java.lang.Object

com.plotsquared.core.configuration.caption.DummyCaptionMap

All Implemented Interfaces:

CaptionMap

public class DummyCaptionMap
extends Object
implements CaptionMap

CaptionMap implementation that throws exception on all getters

Nested Class Summary

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

CaptionMap.NoSuchCaptionException

Constructor Summary

Constructors

Constructor	Description
DummyCaptionMap()

Method Summary

Modifier and Type	Method	Description
@NonNull Set<TranslatableCaption>	getCaptions()	Gets a copy of the set of captions stored in the CaptionMap
@NonNull Locale	getLocale()	Get the locale of the messages stored in the map
@NonNull String	getMessage(@NonNull TranslatableCaption caption)	Get a message using the server locale
@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 java.lang.Object

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

Constructor Details

DummyCaptionMap

public DummyCaptionMap()

Method Details

getMessage

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

Description copied from interface: CaptionMap

Get a message using the server locale

Specified by:

getMessage in interface CaptionMap

Parameters:

caption - Caption containing the caption key

Returns:

Component

Throws:

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

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

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

Parameters:

locale - Locale

Returns:

true if the map supports the locale

getLocale

public @NonNull Locale getLocale()

Description copied from interface: CaptionMap

Get the locale of the messages stored in the map

Specified by:

getLocale in interface CaptionMap

Returns:

Message 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

Returns:

An immutable set of TranslatableCaption