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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BanList.Type	Represents a ban-type that a BanList may track.

Method Summary

Modifier and Type	Method	Description
BanEntry<T>	addBan(String target, String reason, Date expires, String source)	Deprecated. see addBan(Object, String, Date, String)
BanEntry<T>	addBan(T target, String reason, Duration duration, String source)	Adds a ban to this list.
BanEntry<T>	addBan(T target, String reason, Instant expires, String source)	Adds a ban to this list.
BanEntry<T>	addBan(T target, String reason, Date expires, String source)	Adds a ban to this list.
Set<BanEntry>	getBanEntries()	Deprecated. This return a generic class, prefer use getEntries()
BanEntry<T>	getBanEntry(String target)	Deprecated. see getBanEntry(Object)
BanEntry<T>	getBanEntry(T target)	Gets a BanEntry by target.
Set<BanEntry<T>>	getEntries()	Gets a set containing every BanEntry in this list.
boolean	isBanned(String target)	Deprecated. see isBanned(Object)
boolean	isBanned(T target)	Gets if a BanEntry exists for the target, indicating an active ban status.
void	pardon(String target)	Deprecated. see pardon(Object)
void	pardon(T target)	Removes the specified target from this list, therefore indicating a "not banned" status.

Method Details

getBanEntry

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