Interface PermissionManager

Method Details

• getPermission

  @Nullable @Nullable Permission getPermission(@NotNull @NotNull String name)

  Gets a Permission from its fully qualified name

  Parameters:

  name - Name of the permission

  Returns:

  Permission, or null if none

• addPermission

  void addPermission(@NotNull @NotNull Permission perm)

  Adds a Permission to this plugin manager.

  If a permission is already defined with the given name of the new permission, an exception will be thrown.

  Parameters:

  perm - Permission to add

  Throws:

  IllegalArgumentException - Thrown when a permission with the same name already exists

• removePermission

  void removePermission(@NotNull @NotNull Permission perm)

  Removes a Permission registration from this plugin manager.

  If the specified permission does not exist in this plugin manager, nothing will happen.

  Removing a permission registration will not remove the permission from any Permissibles that have it.

  Parameters:

  perm - Permission to remove

• removePermission

  void removePermission(@NotNull @NotNull String name)

  Removes a Permission registration from this plugin manager.

  If the specified permission does not exist in this plugin manager, nothing will happen.

  Removing a permission registration will not remove the permission from any Permissibles that have it.

  Parameters:

  name - Permission to remove

• getDefaultPermissions

  @NotNull @NotNull Set<Permission> getDefaultPermissions(boolean op)

  Gets the default permissions for the given op status

  Parameters:

  op - Which set of default permissions to get

  Returns:

  The default permissions

• recalculatePermissionDefaults

  void recalculatePermissionDefaults(@NotNull @NotNull Permission perm)

  Recalculates the defaults for the given Permission.

  This will have no effect if the specified permission is not registered here.

  Parameters:

  perm - Permission to recalculate

• subscribeToPermission

  void subscribeToPermission(@NotNull @NotNull String permission, @NotNull @NotNull Permissible permissible)

  Subscribes the given Permissible for information about the requested Permission, by name.

  If the specified Permission changes in any form, the Permissible will be asked to recalculate.

  Parameters:

  permission - Permission to subscribe to

  permissible - Permissible subscribing

• unsubscribeFromPermission

  void unsubscribeFromPermission(@NotNull @NotNull String permission, @NotNull @NotNull Permissible permissible)

  Unsubscribes the given Permissible for information about the requested Permission, by name.

  Parameters:

  permission - Permission to unsubscribe from

  permissible - Permissible subscribing

• getPermissionSubscriptions

  @NotNull @NotNull Set<Permissible> getPermissionSubscriptions(@NotNull @NotNull String permission)

  Gets a set containing all subscribed Permissibles to the given permission, by name

  Parameters:

  permission - Permission to query for

  Returns:

  Set containing all subscribed permissions

• subscribeToDefaultPerms

  void subscribeToDefaultPerms(boolean op, @NotNull @NotNull Permissible permissible)

  Subscribes to the given Default permissions by operator status

  If the specified defaults change in any form, the Permissible will be asked to recalculate.

  Parameters:

  op - Default list to subscribe to

  permissible - Permissible subscribing

• unsubscribeFromDefaultPerms

  void unsubscribeFromDefaultPerms(boolean op, @NotNull @NotNull Permissible permissible)

  Unsubscribes from the given Default permissions by operator status

  Parameters:

  op - Default list to unsubscribe from

  permissible - Permissible subscribing

• getDefaultPermSubscriptions

  @NotNull @NotNull Set<Permissible> getDefaultPermSubscriptions(boolean op)

  Gets a set containing all subscribed Permissibles to the given default list, by op status

  Parameters:

  op - Default list to query for

  Returns:

  Set containing all subscribed permissions

• getPermissions

  @NotNull @NotNull Set<Permission> getPermissions()

  Gets a set of all registered permissions.

  This set is a copy and will not be modified live.

  Returns:

  Set containing all current registered permissions

• addPermissions

  void addPermissions(@NotNull @NotNull List<Permission> perm)

  Adds a list of permissions.

  This is meant as an optimization for adding multiple permissions without recalculating each permission.

  Parameters:

  perm - permission

• clearPermissions

  void clearPermissions()

  Clears the current registered permissinos.

  This is used for reloading.