Upstream/bentobox
1
0
Fork 0
mirror of https://github.com/BentoBoxWorld/BentoBox.git synced 2024-11-30 22:53:39 +01:00
Code Issues Projects Releases Wiki Activity

Added some javadoc in PlaceholdersManager

Browse Source
This commit is contained in:
Florian CUNY 2018-11-02 15:44:36 +01:00
parent 1571d8d033
commit dcd8a4ea28
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/main/java/world/bentobox/bentobox/managers/PlaceholdersManager.java
View File

@ -5,6 +5,11 @@ import world.bentobox.bentobox.api.addons.Addon;
import world.bentobox.bentobox.api.placeholders.PlaceholderReplacer; import world.bentobox.bentobox.api.placeholders.PlaceholderReplacer;
import world.bentobox.bentobox.hooks.PlaceholderAPIHook; import world.bentobox.bentobox.hooks.PlaceholderAPIHook;
/**
* Manages placeholder integration.
*
* @author Poslovitch
*/
public class PlaceholdersManager { public class PlaceholdersManager {
private BentoBox plugin; private BentoBox plugin;
@ -13,6 +18,11 @@ public class PlaceholdersManager {
this.plugin = plugin; this.plugin = plugin;
} }
/**
* Registers the placeholder on the behalf on BentoBox.
* @param placeholder the placeholder to register. It will be appended with {@code "bentobox_"} by the placeholder plugin.
* @param replacer the expression that will return a {@code String} when executed, which will replace the placeholder.
*/
public void registerPlaceholder(String placeholder, PlaceholderReplacer replacer) { public void registerPlaceholder(String placeholder, PlaceholderReplacer replacer) {
// Register it in PlaceholderAPI // Register it in PlaceholderAPI
plugin.getHooks().getHook("PlaceholderAPI").ifPresent(hook -> { plugin.getHooks().getHook("PlaceholderAPI").ifPresent(hook -> {
@ -21,6 +31,11 @@ public class PlaceholdersManager {
}); });
} }
/**
* Registers the placeholder on the behalf of the specified addon.
* @param placeholder the placeholder to register. It will be appended with the addon's name by the placeholder plugin.
* @param replacer the expression that will return a {@code String} when executed, which will replace the placeholder.
*/
public void registerPlaceholder(Addon addon, String placeholder, PlaceholderReplacer replacer) { public void registerPlaceholder(Addon addon, String placeholder, PlaceholderReplacer replacer) {
if (addon == null) { if (addon == null) {
registerPlaceholder(placeholder, replacer); registerPlaceholder(placeholder, replacer);