Class PlaceholderResolver

java.lang.Object

io.github.kaktushose.jdac.message.placeholder.PlaceholderResolver

All Implemented Interfaces:

Resolver<String>

public final class PlaceholderResolver
extends Object
implements Resolver<String>

The placeholder resolver is used to do simple placeholder/variable resolution. JDA-Commands uses a format similar to project fluent but with some restrictions.

The overall placeholder format is { $your_placeholder }, with following properties:

• the leading $ is optional
• whitespace, newlines, { and $ are forbidden inside the reference name
• trailing and leading whitespace or newline of the reference name is trimmed (see String.trim()).
• to escape the { character just prefix it with \\ (backslashes can be used unescaped in the rest of the string)

Invalid placeholders will just be treated as literal text.

To get a variables string representation, this resolver:

1. calls Proteus.convert(Object, Type, Type) trying to convert the values to Type.of(String.class)
2. if not successful, just calls Object.toString()

If a variable couldn't be found, null will be inserted.

Constructor Summary

Constructors

Constructor	Description
PlaceholderResolver()

Method Summary

Modifier and Type	Method	Description
int	priority()	The priority of this resolver influences the order in which resolver are applied in a resolution pipeline.
String	resolve(String content, Locale locale, Map<String, @Nullable Object> placeholders)	Resolves the given string according to the class docs.

Methods inherited from class Object

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

Methods inherited from interface Resolver

resolve, resolve, resolve

Constructor Details

PlaceholderResolver

public PlaceholderResolver()

Method Details

resolve

public String resolve(String content,
 Locale locale,
 Map<String, @Nullable Object> placeholders)

Resolves the given string according to the class docs.

Specified by:

resolve in interface Resolver<String>

Parameters:

content - the string to be resolved

locale - the locale - unused in this resolver

placeholders - the placeholders to be used

Returns:

the string with placeholders replaced by their value

priority

public int priority()

Description copied from interface: Resolver

The priority of this resolver influences the order in which resolver are applied in a resolution pipeline.

Currently, this only applies to Resolver<String>, when using MessageResolver (as JDA-Commands does internally). Generally speaking, resolvers with lower priority run first.

If the priority isn't important (e.g. for ComponentResolver) this should return 0.

Specified by:

priority in interface Resolver<String>

Returns:

1000