Package org.kingdoms.locale.placeholders.context

Class PlaceholderContextBuilder

java.lang.Object

org.kingdoms.locale.placeholders.context.PlaceholderContextBuilder

All Implemented Interfaces:

Cloneable, org.kingdoms.locale.placeholders.context.LocalPlaceholderProvider, PlaceholderProvider, org.kingdoms.locale.placeholders.target.BasePlaceholderTargetProvider, org.kingdoms.locale.placeholders.target.PlaceholderTargetProvider

Direct Known Subclasses:

MessagePlaceholderProvider

public class PlaceholderContextBuilder
extends Object
implements Cloneable, org.kingdoms.locale.placeholders.context.LocalPlaceholderProvider, org.kingdoms.locale.placeholders.target.PlaceholderTargetProvider

Nested Class Summary

Nested classes/interfaces inherited from interface org.kingdoms.locale.placeholders.target.BasePlaceholderTargetProvider

org.kingdoms.locale.placeholders.target.BasePlaceholderTargetProvider.Companion

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,PlaceholderProvider>	children	Should be used for placeholder targets for future updates.
static final PlaceholderContextBuilder	DEFAULT
protected Map<String,Object>	placeholders	Can be either: PlaceholderTranslationContext MessageObjectBuilder any other object counts as a raw placeholder
protected Object	primaryTarget
protected Object	secondaryTarget
protected Map<String,Object>	targets
protected PlaceholderProvider	unknownPlaceholderHandler

Fields inherited from interface org.kingdoms.locale.placeholders.target.BasePlaceholderTargetProvider

Companion, EMPTY

Fields inherited from interface org.kingdoms.locale.placeholders.context.PlaceholderProvider

EMPTY

Constructor Summary

Constructors

Constructor	Description
PlaceholderContextBuilder()

Method Summary

Modifier and Type	Method	Description
PlaceholderContextBuilder	addAll(Map<String,Object> placeholders)
PlaceholderContextBuilder	addAllIfAbsent(Map<String,Object> placeholders)
PlaceholderContextBuilder	addChild(String id, Supplier<PlaceholderProvider> provider)
PlaceholderContextBuilder	addChild(String id, PlaceholderProvider provider)
PlaceholderContextBuilder	addTarget(String name, Object target)
PlaceholderContextBuilder	clone()
<T extends PlaceholderContextBuilder> T	cloneInto(T ctx)
PlaceholderContextBuilder	ensurePlaceholdersCapacity(int amount)
Map<String,PlaceholderProvider>	getChildren()
Object	getPlaceholder(String str)
Map<String,Object>	getPlaceholders()
@Nullable Object	getPrimaryTarget()
@Nullable Object	getSecondaryTarget()
@NonNull Map<String,Object>	getTargets()
protected Map<String,Object>	getTargets0()
PlaceholderProvider	getUnknownPlaceholderHandler()
boolean	hasContext()
PlaceholderContextBuilder	impregnate(int capacity)
PlaceholderContextBuilder	inheritContext(org.kingdoms.locale.placeholders.target.BasePlaceholderTargetProvider other, boolean replace)
PlaceholderContextBuilder	inheritPlaceholders(PlaceholderContextBuilder other)
PlaceholderProvider	onUnknownPlaceholder(PlaceholderProvider unknownPlaceholderHandler)
PlaceholderContextBuilder	other(org.bukkit.entity.Player other)
PlaceholderContextBuilder	other(Kingdom other)
PlaceholderContextBuilder	other(org.kingdoms.locale.placeholders.target.PlaceholderTarget target)
PlaceholderContextBuilder	parse(String variable, Object replacement)
PlaceholderContextBuilder	parse(String variable, Supplier<Object> replacement)
PlaceholderContextBuilder	placeholders(Object... edits)
@Nullable Object	provideLocalPlaceholder(@NotNull org.kingdoms.locale.placeholders.PlaceholderParts placeholder)
Object	providePlaceholder(String placeholder)
PlaceholderContextBuilder	raw(String variable, Object replacement)
PlaceholderContextBuilder	raw(String variable, Supplier<Object> replacement)
PlaceholderContextBuilder	raws(Object... edits)
PlaceholderContextBuilder	resetPlaceholders()
void	setChildren(Map<String,PlaceholderProvider> children)
void	setPrimaryTarget(Object primaryTarget)
void	setSecondaryTarget(Object secondaryTarget)
org.kingdoms.locale.placeholders.target.PlaceholderTargetProvider	switchTargets()
String	toString()
protected PlaceholderContextBuilder	variables(boolean raw, Object[] edits)
PlaceholderContextBuilder	withContext(org.bukkit.command.CommandSender sender)
PlaceholderContextBuilder	withContext(org.bukkit.entity.Player player)
PlaceholderContextBuilder	withContext(org.bukkit.OfflinePlayer player)
PlaceholderContextBuilder	withContext(Group group)
PlaceholderContextBuilder	withContext(Kingdom kingdom)
PlaceholderContextBuilder	withContext(Nation nation)
PlaceholderContextBuilder	withContext(KingdomPlayer player)
PlaceholderContextBuilder	withContext(org.kingdoms.locale.placeholders.target.PlaceholderTarget target)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kingdoms.locale.placeholders.target.PlaceholderTargetProvider

getTargetProviderFor

Field Details

DEFAULT

public static final PlaceholderContextBuilder DEFAULT

placeholders

protected Map<String,Object> placeholders

Can be either: PlaceholderTranslationContext MessageObjectBuilder any other object counts as a raw placeholder

children

protected Map<String,PlaceholderProvider> children

Should be used for placeholder targets for future updates. %target*placeholder% e.g. %third_kingdom*kingdoms_kingdom_name%

But how does one compare the relations between multiple targets? Maybe a second op? %target**placeholder% would put the "target"s main context into relationalSecond of the current context.

unknownPlaceholderHandler

protected PlaceholderProvider unknownPlaceholderHandler

primaryTarget

protected Object primaryTarget

secondaryTarget

protected Object secondaryTarget

targets

protected Map<String,Object> targets

Constructor Details

PlaceholderContextBuilder

public PlaceholderContextBuilder()

Method Details

providePlaceholder

public Object providePlaceholder(String placeholder)

Specified by:

providePlaceholder in interface PlaceholderProvider

provideLocalPlaceholder

@Nullable
public @Nullable Object provideLocalPlaceholder(@NotNull
 @NotNull org.kingdoms.locale.placeholders.PlaceholderParts placeholder)

Specified by:

provideLocalPlaceholder in interface org.kingdoms.locale.placeholders.context.LocalPlaceholderProvider

clone

public PlaceholderContextBuilder clone()

Overrides:

clone in class Object

cloneInto

public <T extends PlaceholderContextBuilder> T cloneInto(T ctx)

setChildren

public void setChildren(Map<String,PlaceholderProvider> children)

getChildren

public Map<String,PlaceholderProvider> getChildren()

ensurePlaceholdersCapacity

public PlaceholderContextBuilder ensurePlaceholdersCapacity(int amount)

impregnate

public PlaceholderContextBuilder impregnate(int capacity)

addChild

public PlaceholderContextBuilder addChild(String id,
 Supplier<PlaceholderProvider> provider)

addChild

public PlaceholderContextBuilder addChild(String id,
 PlaceholderProvider provider)

Returns:

the CURRENT builder, not the new one.

inheritPlaceholders

public PlaceholderContextBuilder inheritPlaceholders(PlaceholderContextBuilder other)

inheritContext

public PlaceholderContextBuilder inheritContext(org.kingdoms.locale.placeholders.target.BasePlaceholderTargetProvider other,
 boolean replace)

addAll

public PlaceholderContextBuilder addAll(Map<String,Object> placeholders)

addAllIfAbsent

public PlaceholderContextBuilder addAllIfAbsent(Map<String,Object> placeholders)

raws

public PlaceholderContextBuilder raws(Object... edits)

placeholders

public PlaceholderContextBuilder placeholders(Object... edits)

variables

protected PlaceholderContextBuilder variables(boolean raw,
 Object[] edits)

getPlaceholders

public Map<String,Object> getPlaceholders()

hasContext

public boolean hasContext()

addTarget

public PlaceholderContextBuilder addTarget(String name,
 Object target)

withContext

public PlaceholderContextBuilder withContext(org.bukkit.entity.Player player)

withContext

public PlaceholderContextBuilder withContext(KingdomPlayer player)

withContext

public PlaceholderContextBuilder withContext(org.kingdoms.locale.placeholders.target.PlaceholderTarget target)

withContext

public PlaceholderContextBuilder withContext(org.bukkit.OfflinePlayer player)

withContext

public PlaceholderContextBuilder withContext(org.bukkit.command.CommandSender sender)

withContext

public PlaceholderContextBuilder withContext(Kingdom kingdom)

withContext

public PlaceholderContextBuilder withContext(Nation nation)

withContext

public PlaceholderContextBuilder withContext(Group group)

getUnknownPlaceholderHandler

public PlaceholderProvider getUnknownPlaceholderHandler()

onUnknownPlaceholder

public PlaceholderProvider onUnknownPlaceholder(PlaceholderProvider unknownPlaceholderHandler)

other

public PlaceholderContextBuilder other(org.kingdoms.locale.placeholders.target.PlaceholderTarget target)

other

public PlaceholderContextBuilder other(org.bukkit.entity.Player other)

other

public PlaceholderContextBuilder other(Kingdom other)

resetPlaceholders

public PlaceholderContextBuilder resetPlaceholders()

parse

public PlaceholderContextBuilder parse(String variable,
 Object replacement)

parse

public PlaceholderContextBuilder parse(String variable,
 Supplier<Object> replacement)

raw

public PlaceholderContextBuilder raw(String variable,
 Supplier<Object> replacement)

raw

public PlaceholderContextBuilder raw(String variable,
 Object replacement)

getPlaceholder

public Object getPlaceholder(String str)

toString

public String toString()

Overrides:

toString in class Object

setPrimaryTarget

public void setPrimaryTarget(Object primaryTarget)

setSecondaryTarget

public void setSecondaryTarget(Object secondaryTarget)

switchTargets

public org.kingdoms.locale.placeholders.target.PlaceholderTargetProvider switchTargets()

Specified by:

switchTargets in interface org.kingdoms.locale.placeholders.target.PlaceholderTargetProvider

getPrimaryTarget

@Nullable
public @Nullable Object getPrimaryTarget()

Specified by:

getPrimaryTarget in interface org.kingdoms.locale.placeholders.target.BasePlaceholderTargetProvider

getSecondaryTarget

@Nullable
public @Nullable Object getSecondaryTarget()

Specified by:

getSecondaryTarget in interface org.kingdoms.locale.placeholders.target.BasePlaceholderTargetProvider

getTargets0

@Internal
protected Map<String,Object> getTargets0()

getTargets

public @NonNull Map<String,Object> getTargets()

Specified by:

getTargets in interface org.kingdoms.locale.placeholders.target.PlaceholderTargetProvider