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 BanList

BanList.Type

Method Summary

Modifier and Type	Method	Description
@Nullable BanEntry<PlayerProfile>	addBan(PlayerProfile target, @Nullable String reason, @Nullable Date expires, @Nullable String source)	Adds a ban to this list.
<E extends BanEntry<? super PlayerProfile>> @Nullable E	addBan(PlayerProfile target, @Nullable String reason, @Nullable Duration duration, @Nullable String source)	Deprecated. use BanList.addBan(Object, String, Duration, String)
<E extends BanEntry<? super PlayerProfile>> @Nullable E	addBan(PlayerProfile target, @Nullable String reason, @Nullable Instant expires, @Nullable String source)	Deprecated. use BanList.addBan(Object, String, Instant, String)
<E extends BanEntry<? super PlayerProfile>> @Nullable E	addBan(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>> @Nullable E	getBanEntry(PlayerProfile target)	Deprecated. use BanList.getBanEntry(Object)
boolean	isBanned(PlayerProfile target)	Deprecated. use BanList.isBanned(Object)
void	pardon(PlayerProfile target)	Deprecated. use BanList.pardon(Object)

Methods inherited from interface BanList

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

Method Details

addBan

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

Deprecated.

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

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

Type Parameters:

E - the type of the ban 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

Throws:

IllegalArgumentException - if ProfilePlayer has an invalid UUID

addBan

@Nullable BanEntry<PlayerProfile> addBan(PlayerProfile 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.

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
<E extends BanEntry<? super PlayerProfile>>
@Nullable E getBanEntry(PlayerProfile target)

Deprecated.

use BanList.getBanEntry(Object)

Gets a BanEntry by target.

Type Parameters:

E - the type of the ban entry

Parameters:

target - entry parameter to search for

Returns:

the corresponding entry, or null if none found

isBanned

@Deprecated
boolean isBanned(PlayerProfile target)

Deprecated.

use BanList.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

@Deprecated
void pardon(PlayerProfile target)

Deprecated.

use BanList.pardon(Object)

Removes the specified target from this list, therefore indicating a "not banned" status.

Parameters:

target - the target to remove from this list

addBan

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

Deprecated.

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

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

Type Parameters:

E - the type of the ban 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

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

Deprecated.

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

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

Type Parameters:

E - the type of the ban 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