Package com.plotsquared.core.permissions

Interface PermissionHolder

All Known Subinterfaces:
OfflinePlotPlayer
All Known Implementing Classes:
ConsolePlayer, PlotPlayer
public interface PermissionHolder
Any object which can hold permissions

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    hasKeyedPermission​(@NonNull String permission, @NonNull String key)
    Check if the owner of the profile has a given (global) keyed permission.
    boolean
    hasKeyedPermission​(@Nullable String world, @NonNull String permission, @NonNull String key)
    Check if the owner of the profile has a given keyed permission.
    default boolean
    hasPermission​(@NonNull String permission)
    Check if the owner of the profile has a given (global) permission
    boolean
    hasPermission​(@Nullable String world, @NonNull String permission)
    Check if the owner of the profile has a given permission
    default @org.checkerframework.checker.index.qual.NonNegative int
    hasPermissionRange​(@NonNull String stub, @org.checkerframework.checker.index.qual.NonNegative int range)
    Check the highest permission a PlotPlayer has within a specified range.
    - Excessively high values will lag
    - The default range that is checked is Settings.Limit.MAX_PLOTS

  • Method Details

    • hasPermission

      default boolean hasPermission​(@NonNull String permission)
      Check if the owner of the profile has a given (global) permission
      Parameters:
      permission - Permission
      Returns:
      true if the owner has the given permission, else false

    • hasKeyedPermission

      default boolean hasKeyedPermission​(@NonNull String permission, @NonNull String key)
      Check if the owner of the profile has a given (global) keyed permission. Checks both permission.key and permission.*
      Parameters:
      permission - Permission
      key - Permission "key"
      Returns:
      true if the owner has the given permission, else false

    • hasPermissionRange

      default @org.checkerframework.checker.index.qual.NonNegative int hasPermissionRange​(@NonNull String stub, @org.checkerframework.checker.index.qual.NonNegative int range)
      Check the highest permission a PlotPlayer has within a specified range.
      - Excessively high values will lag
      - The default range that is checked is Settings.Limit.MAX_PLOTS
      Parameters:
      stub - The permission stub to check e.g. for `plots.plot.#` the stub is `plots.plot`
      range - The range to check
      Returns:
      The highest permission they have within that range

    • hasPermission

      boolean hasPermission​(@Nullable String world, @NonNull String permission)
      Check if the owner of the profile has a given permission
      Parameters:
      world - World name
      permission - Permission
      Returns:
      true if the owner has the given permission, else false

    • hasKeyedPermission

      boolean hasKeyedPermission​(@Nullable String world, @NonNull String permission, @NonNull String key)
      Check if the owner of the profile has a given keyed permission. Checks both permission.key and permission.*
      Parameters:
      world - World name
      permission - Permission
      key - Permission "key"
      Returns:
      true if the owner has the given permission, else false