Improved GameModePlaceholderReplacer javadoc

This commit is contained in:
Florian CUNY 2019-06-16 09:19:23 +02:00
parent 07be933a9d
commit 98cb301070

View File

@ -14,6 +14,12 @@ import world.bentobox.bentobox.database.objects.Island;
@FunctionalInterface
public interface GameModePlaceholderReplacer {
/**
* @param addon the GameModeAddon that registered the placeholder, cannot be null.
* @param user the User to which the placeholder will be shown, can be null.
* @param island the Island of the User, can be null.
* @return the String containing the requested value or an empty String.
*/
@NonNull
String onReplace(@NonNull GameModeAddon addon, @Nullable User user, @Nullable Island island);
}