Package org.bukkit
Interface BanList
public interface BanList
A ban list, containing bans of some
BanList.Type
.-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddBan
(@NotNull String target, @Nullable String reason, @Nullable Date expires, @Nullable String source) Adds a ban to the this list.Gets a set containing everyBanEntry
in this list.getBanEntry
(@NotNull String target) Gets aBanEntry
by target.boolean
Gets if aBanEntry
exists for the target, indicating an active ban status.void
Removes the specified target from this list, therefore indicating a "not banned" status.
-
Method Details
-
getBanEntry
Gets aBanEntry
by target.- Parameters:
target
- entry parameter to search for- Returns:
- the corresponding entry, or null if none found
-
addBan
@Nullable @Nullable BanEntry addBan(@NotNull @NotNull String target, @Nullable @Nullable String reason, @Nullable @Nullable Date expires, @Nullable @Nullable String source) Adds a ban to the this list. If a previous ban exists, this will update the previous entry.- Parameters:
target
- the target of the banreason
- reason for the ban, null indicates implementation defaultexpires
- date for the ban's expiration (unban), or null to imply foreversource
- 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
Gets a set containing everyBanEntry
in this list.- Returns:
- an immutable set containing every entry tracked by this list
-
isBanned
Gets if aBanEntry
exists for the target, indicating an active ban status.- Parameters:
target
- the target to find- Returns:
- true if a
BanEntry
exists for the name, indicating an active ban status, false otherwise
-
pardon
Removes the specified target from this list, therefore indicating a "not banned" status.- Parameters:
target
- the target to remove from this list
-