org.bukkit

Interface BanList

public interface BanList

A ban list, containing bans of type BanList.Type

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BanList.Type Represents the various types a BanList may track.

Method Summary

Methods

Modifier and Type	Method and Description
BanEntry	addBan(String target, String reason, Date expires, String source) Adds a ban to the ban list.
Set<BanEntry>	getBanEntries() Gets a set containing every BanEntry in the BanList.
BanEntry	getBanEntry(String target) Gets a BanEntry by target.
boolean	isBanned(String target) Gets if a BanEntry exists for the target, indicating ban status
void	pardon(String target) Removes the specified target from the list, therefore indicating a "not banned" status.

Method Detail

getBanEntry

BanEntry getBanEntry(String target)

Gets a BanEntry by target.

Parameters:

target - Entry parameter to search for

Returns:

BanEntry for the submitted query, or null if none found

addBan

BanEntry addBan(String target,
              String reason,
              Date expires,
              String source)

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

Parameters:

target - The target of the ban

reason - Reason for the ban. If null, the implementation default is assumed

expires - Expiration Date of the ban. If null, "infinity" is assumed

source - Source of the ban. If null, the implementation default is assumed

Returns:

The BanEntry of the added ban

getBanEntries

Set<BanEntry> getBanEntries()

Gets a set containing every BanEntry in the BanList.

Returns:

an immutable set containing every BanEntry tracked by the BanList

isBanned

boolean isBanned(String target)

Gets if a BanEntry exists for the target, indicating ban status

Parameters:

target - Entry target to lookup

Returns:

true if a BanEntry exists for the name, indicating ban status

pardon

void pardon(String target)

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

Parameters:

target - The target to remove from the list