Package org.bukkit

Interface BanList<T>

Type Parameters:
T - The ban target
All Known Subinterfaces:
IpBanList, ProfileBanList
public interface BanList<T>
A ban list, containing bans of some BanList.Type.

  • Method Details

    • getBanEntry

      @Deprecated @Nullable BanEntry<T> getBanEntry(@NotNull String target)
      Deprecated.
      see getBanEntry(Object)
      Gets a BanEntry by target.
      Parameters:
      target - entry parameter to search for
      Returns:
      the corresponding entry, or null if none found

    • getBanEntry

      @Nullable BanEntry<T> getBanEntry(@NotNull T target)
      Gets a BanEntry by target.
      Parameters:
      target - entry parameter to search for
      Returns:
      the corresponding entry, or null if none found

    • addBan

      @Deprecated @Nullable BanEntry<T> addBan(@NotNull String target, @Nullable String reason, @Nullable Date expires, @Nullable String source)
      Deprecated.
      see addBan(Object, String, Date, String)
      Adds a ban to this list. If a previous ban exists, this will update the previous entry.
      Parameters:
      target - the target of the ban
      reason - reason for the ban, null indicates implementation default
      expires - date for the ban's expiration (unban), or null to imply forever
      source - source of the ban, null indicates implementation default
      Returns:
      the entry for the newly created ban, or the entry for the (updated) previous ban

    • addBan

      @Nullable BanEntry<T> addBan(@NotNull T target, @Nullable String reason, @Nullable Date expires, @Nullable String source)
      Adds a ban to this list. If a previous ban exists, this will update the previous entry.
      Parameters:
      target - the target of the ban
      reason - reason for the ban, null indicates implementation default
      expires - date for the ban's expiration (unban), or null to imply forever
      source - source of the ban, null indicates implementation default
      Returns:
      the entry for the newly created ban, or the entry for the (updated) previous ban

    • addBan

      @Nullable BanEntry<T> addBan(@NotNull T target, @Nullable String reason, @Nullable Instant expires, @Nullable String source)
      Adds a ban to this list. If a previous ban exists, this will update the previous entry.
      Parameters:
      target - the target of the ban
      reason - reason for the ban, null indicates implementation default
      expires - instant for the ban's expiration (unban), or null to imply forever
      source - source of the ban, null indicates implementation default
      Returns:
      the entry for the newly created ban, or the entry for the (updated) previous ban

    • addBan

      @Nullable BanEntry<T> addBan(@NotNull T target, @Nullable String reason, @Nullable Duration duration, @Nullable String source)
      Adds a ban to this list. If a previous ban exists, this will update the previous entry.
      Parameters:
      target - the target of the ban
      reason - reason for the ban, null indicates implementation default
      duration - the duration of the ban, or null to imply forever
      source - source of the ban, null indicates implementation default
      Returns:
      the entry for the newly created ban, or the entry for the (updated) previous ban

    • getBanEntries

      @Deprecated @NotNull Set<BanEntry> getBanEntries()
      Deprecated.
      This return a generic class, prefer use getEntries()
      Gets a set containing every BanEntry in this list.
      Returns:
      an immutable set containing every entry tracked by this list

    • getEntries

      @NotNull Set<BanEntry<T>> getEntries()
      Gets a set containing every BanEntry in this list.
      Returns:
      an immutable set containing every entry tracked by this list

    • isBanned

      boolean isBanned(@NotNull T target)
      Gets if a BanEntry exists for the target, indicating an active ban status.
      Parameters:
      target - the target to find
      Returns:
      true if a BanEntry exists for the target, indicating an active ban status, false otherwise

    • isBanned

      @Deprecated boolean isBanned(@NotNull String target)
      Deprecated.
      see isBanned(Object)
      Gets if a BanEntry exists for the target, indicating an active ban status.
      Parameters:
      target - the target to find
      Returns:
      true if a BanEntry exists for the target, indicating an active ban status, false otherwise

    • pardon

      void pardon(@NotNull T target)
      Removes the specified target from this list, therefore indicating a "not banned" status.
      Parameters:
      target - the target to remove from this list

    • pardon

      @Deprecated void pardon(@NotNull String target)
      Deprecated.
      see pardon(Object)
      Removes the specified target from this list, therefore indicating a "not banned" status.
      Parameters:
      target - the target to remove from this list