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(since="1.20.1") @Nullable <E extends BanEntry<? super T>> E getBanEntry(@NotNull @NotNull String target)
      Deprecated.
      see getBanEntry(Object)
      Gets a BanEntry by target.

      Bans by name for ban type NAME are no longer supported and this method will return null when trying to request them. The replacement is bans by UUID.

      Parameters:
      target - entry parameter to search for
      Returns:
      the corresponding entry, or null if none found

    • getBanEntry

      @Nullable @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(since="1.20.1") @Nullable <E extends BanEntry<? super T>> E addBan(@NotNull @NotNull String target, @Nullable @Nullable String reason, @Nullable @Nullable Date expires, @Nullable @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.

      Bans by name for ban type NAME are no longer supported and this method will return null when trying to request them. The replacement is bans by UUID.

      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 @Nullable BanEntry<T> addBan(@NotNull T target, @Nullable @Nullable String reason, @Nullable @Nullable Date expires, @Nullable @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 @Nullable BanEntry<T> addBan(@NotNull T target, @Nullable @Nullable String reason, @Nullable @Nullable Instant expires, @Nullable @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 @Nullable BanEntry<T> addBan(@NotNull T target, @Nullable @Nullable String reason, @Nullable @Nullable Duration duration, @Nullable @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(since="1.20.1") @NotNull @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 <E extends BanEntry<? super T>> @NotNull Set<E> 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.

      Bans by name for ban type NAME are no longer supported. The replacement is bans by UUID.

      Parameters:
      target - the target to find
      Returns:
      true if a BanEntry exists for the target, indicating an active ban status, false otherwise

    • isBanned

      @Deprecated(since="1.20.1") boolean isBanned(@NotNull @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.

      Bans by name for ban type NAME are no longer supported. The replacement is bans by UUID.

      Parameters:
      target - the target to remove from this list

    • pardon

      @Deprecated(since="1.20.1") void pardon(@NotNull @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