Package org.bukkit.ban

Interface ProfileBanList

All Superinterfaces:

BanList<PlayerProfile>

public interface ProfileBanList
extends BanList<PlayerProfile>

A BanList targeting player profile bans.

Nested Class Summary

Nested classes/interfaces inherited from interface org.bukkit.BanList

BanList.Type

Method Summary

Modifier and Type	Method	Description
@Nullable BanEntry<PlayerProfile>	addBan(@NotNull PlayerProfile target, @Nullable String reason, @Nullable Date expires, @Nullable String source)	Adds a ban to this list.
<E extends BanEntry<? super PlayerProfile>> E	addBan(@NotNull PlayerProfile target, @Nullable String reason, @Nullable Date expires, @Nullable String source)	Deprecated. use addBan(com.destroystokyo.paper.profile.PlayerProfile, String, Date, String)
<E extends BanEntry<? super PlayerProfile>> E	addBan(@NotNull PlayerProfile target, @Nullable String reason, Duration duration, @Nullable String source)	Deprecated. use BanList.addBan(Object, String, java.time.Duration, String)
<E extends BanEntry<? super PlayerProfile>> E	addBan(@NotNull PlayerProfile target, @Nullable String reason, Instant expires, @Nullable String source)	Deprecated. use BanList.addBan(Object, String, java.time.Instant, String)
<E extends BanEntry<? super PlayerProfile>> E	getBanEntry(@NotNull PlayerProfile target)	Deprecated. use BanList.getBanEntry(Object)
boolean	isBanned(@NotNull PlayerProfile target)	Deprecated. use BanList.isBanned(Object)
void	pardon(@NotNull PlayerProfile target)	Deprecated. use BanList.pardon(Object)

Methods inherited from interface org.bukkit.BanList

addBan, addBan, addBan, getBanEntries, getBanEntry, getBanEntry, getEntries, isBanned, isBanned, pardon, pardon

Method Details

addBan

@Nullable
@Deprecated
<E extends BanEntry<? super PlayerProfile>> E addBan(@NotNull
 @NotNull PlayerProfile target,
 @Nullable
 @Nullable String reason,
 @Nullable
 @Nullable Date expires,
 @Nullable
 @Nullable String source)

Deprecated.

use addBan(com.destroystokyo.paper.profile.PlayerProfile, String, Date, String)

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

Throws:

IllegalArgumentException - if ProfilePlayer has an invalid UUID

addBan

@Nullable
@Nullable BanEntry<PlayerProfile> addBan(@NotNull PlayerProfile target,
 @Nullable
 @Nullable String reason,
 @Nullable
 @Nullable Date expires,
 @Nullable
 @Nullable String source)

Description copied from interface: BanList

Adds a ban to this list. If a previous ban exists, this will update the previous entry.

Specified by:

addBan in interface BanList<PlayerProfile>

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

Throws:

IllegalArgumentException - if ProfilePlayer has an invalid UUID

getBanEntry

@Deprecated
@Nullable
<E extends BanEntry<? super PlayerProfile>> E getBanEntry(@NotNull
 @NotNull PlayerProfile target)

Deprecated.

use BanList.getBanEntry(Object)

isBanned

@Deprecated
boolean isBanned(@NotNull
 @NotNull PlayerProfile target)

Deprecated.

use BanList.isBanned(Object)

pardon

@Deprecated
void pardon(@NotNull
 @NotNull PlayerProfile target)

Deprecated.

use BanList.pardon(Object)

addBan

@Deprecated
@Nullable
<E extends BanEntry<? super PlayerProfile>> E addBan(@NotNull
 @NotNull PlayerProfile target,
 @Nullable
 @Nullable String reason,
 @Nullable
 Instant expires,
 @Nullable
 @Nullable String source)

Deprecated.

use BanList.addBan(Object, String, java.time.Instant, String)

addBan

@Deprecated
@Nullable
<E extends BanEntry<? super PlayerProfile>> E addBan(@NotNull
 @NotNull PlayerProfile target,
 @Nullable
 @Nullable String reason,
 @Nullable
 Duration duration,
 @Nullable
 @Nullable String source)

Deprecated.

use BanList.addBan(Object, String, java.time.Duration, String)