Package org.incendo.cloud.translations.minecraft.extras

Class AudienceLocaleExtractor<C>

java.lang.Object

org.incendo.cloud.translations.minecraft.extras.AudienceLocaleExtractor<C>

All Implemented Interfaces:

Function<C,@Nullable Locale>, LocaleExtractor<C>

@DefaultQualifier(org.checkerframework.checker.nullness.qual.NonNull.class)
public final class AudienceLocaleExtractor<C>
extends Object
implements LocaleExtractor<C>, Function<C,@Nullable Locale>

Nested Class Summary

Nested classes/interfaces inherited from interface org.incendo.cloud.translations.LocaleExtractor

LocaleExtractor.Builder<C extends Object>

Method Summary

Modifier and Type	Method	Description
@Nullable Locale	apply(C recipient)
static <C extends Audience> AudienceLocaleExtractor<C>	audienceLocaleExtractor()	Returns a locale extractor that uses the locale pointer to extract a Locale from the sender.
static <C> AudienceLocaleExtractor<C>	audienceLocaleExtractor(AudienceProvider<C> audienceProvider)	Returns a locale extractor that uses the locale pointer to extract a Locale from the sender as an audience as mapped by audienceProvider.
AudienceLocaleExtractor<C>	defaulted(@NonNull LocaleExtractor<C> fallback)	Returns a copy of this extractor that falls back to the provided extractor when the locale pointer does not have a value for a given audience.
Locale	extract(C recipient)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Method Details

audienceLocaleExtractor

public static <C> AudienceLocaleExtractor<C> audienceLocaleExtractor(AudienceProvider<C> audienceProvider)

Returns a locale extractor that uses the locale pointer to extract a Locale from the sender as an audience as mapped by audienceProvider.

Type Parameters:

C - command sender type

Parameters:

audienceProvider - audience provider

Returns:

extractor

audienceLocaleExtractor

public static <C extends Audience>
AudienceLocaleExtractor<C> audienceLocaleExtractor()

Returns a locale extractor that uses the locale pointer to extract a Locale from the sender.

Type Parameters:

C - command sender type

Returns:

extractor

extract

public Locale extract(C recipient)

Specified by:

extract in interface LocaleExtractor<C>

apply

public @Nullable Locale apply(C recipient)

Specified by:

apply in interface Function<C,@Nullable Locale>

defaulted

public AudienceLocaleExtractor<C> defaulted(@NonNull LocaleExtractor<C> fallback)

Returns a copy of this extractor that falls back to the provided extractor when the locale pointer does not have a value for a given audience.

Note that this only applies to extract(Object). apply(Object) will always return null when the pointer does not have a value, as it is meant for use with LocaleExtractor.Builder

Parameters:

fallback - fallback extractor

Returns:

defaulted extractor