87 lines
2.8 KiB
Java
87 lines
2.8 KiB
Java
package fr.pandacube.lib.players.permissible;
|
|
|
|
import java.util.OptionalLong;
|
|
import java.util.stream.LongStream;
|
|
|
|
import fr.pandacube.lib.permissions.PermissionExpressionParser;
|
|
import fr.pandacube.lib.players.standalone.AbstractOnlinePlayer;
|
|
|
|
/**
|
|
* Represents an online player, with extra methods related to the {@code pandalib-permissions} system.
|
|
*/
|
|
public interface PermissibleOnlinePlayer extends PermissibleOffPlayer, AbstractOnlinePlayer {
|
|
|
|
|
|
|
|
|
|
/*
|
|
* General data and state
|
|
*/
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
* @implSpec The implementation is expected to call the environment API
|
|
* (Bukkit/Bungee) to get the name of the player.
|
|
*/
|
|
String getName();
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
* Permissions and groups
|
|
*/
|
|
|
|
/**
|
|
* Tells if this online player has the specified permission.
|
|
* @implSpec the implementation of this method must not directly or
|
|
* indirectly call the method {@link PermissibleOffPlayer#hasPermission(String)},
|
|
* or it may result in a {@link StackOverflowError}.
|
|
*/
|
|
boolean hasPermission(String permission);
|
|
|
|
/**
|
|
* Tells if this online player has the permission resulted from the provided expression.
|
|
* @implSpec the implementation of this method must not directly or
|
|
* indirectly call the method {@link PermissibleOffPlayer#hasPermissionExpression(String)},
|
|
* or it may result in a {@link StackOverflowError}.
|
|
*/
|
|
default boolean hasPermissionExpression(String permissionExpression) {
|
|
return PermissionExpressionParser.evaluate(permissionExpression, this::hasPermission);
|
|
}
|
|
|
|
/**
|
|
* Lists all the values for a set of permission indicating an integer in a range.
|
|
* <p>
|
|
* A permission range is used to easily attribute a number to a group or player,
|
|
* like the maximum number of homes allowed. For instance, if the player has the permission
|
|
* {@code essentials.home.12}, this method would return a stream containing the value 12,
|
|
* if the parameter {@code permissionPrefix} is {@code "essentials.home."}.
|
|
* <p>
|
|
* The use of a stream allow the caller to get either the maximum, the minimum, or do any
|
|
* other treatment to the values.
|
|
* @param permissionPrefix the permission prefix to search for.
|
|
* @return a LongStream containing all the values found for the specified permission prefix.
|
|
*/
|
|
default LongStream getPermissionRangeValues(String permissionPrefix) {
|
|
String server = getServerName();
|
|
String world = server == null ? null : getWorldName();
|
|
return getPermissionUser().getPermissionRangeValues(permissionPrefix, server, world);
|
|
}
|
|
|
|
/**
|
|
* Returns the maximum value returned by {@link PermissibleOffPlayer#getPermissionRangeValues(String)}.
|
|
*/
|
|
default OptionalLong getPermissionRangeMax(String permissionPrefix) {
|
|
String server = getServerName();
|
|
String world = server == null ? null : getWorldName();
|
|
return getPermissionUser().getPermissionRangeMax(permissionPrefix, server, world);
|
|
}
|
|
|
|
|
|
|
|
}
|