com.sk89q.worldguard.blacklist

Class BlacklistEntry

java.lang.Object

com.sk89q.worldguard.blacklist.BlacklistEntry

public class BlacklistEntry
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BlacklistEntry(Blacklist blacklist) Construct the object.

Method Summary

Modifier and Type	Method and Description
boolean	check(boolean useAsWhitelist, BlacklistEvent event, boolean forceRepeat, boolean silent) Method to handle the event.
java.util.List<Action>	getActions(java.lang.Class<? extends BlacklistEvent> eventCls) Get the associated actions with an event.
java.lang.String	getComment()
java.lang.String[]	getIgnoreGroups()
java.lang.String[]	getIgnorePermissions()
java.lang.String	getMessage()
void	setComment(java.lang.String comment)
void	setIgnoreGroups(java.lang.String[] ignoreGroups)
void	setIgnorePermissions(java.lang.String[] ignorePermissions)
void	setMessage(java.lang.String message)
boolean	shouldIgnore(LocalPlayer player) Returns true if this player should be ignored.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlacklistEntry

public BlacklistEntry(Blacklist blacklist)

Construct the object.

Parameters:

blacklist - The blacklist that contains this entry

Method Detail

getIgnoreGroups

public java.lang.String[] getIgnoreGroups()

Returns:

the ignoreGroups

getIgnorePermissions

public java.lang.String[] getIgnorePermissions()

Returns:

the ignoreGroups

setIgnoreGroups

public void setIgnoreGroups(java.lang.String[] ignoreGroups)

Parameters:

ignoreGroups - the ignoreGroups to set

setIgnorePermissions

public void setIgnorePermissions(java.lang.String[] ignorePermissions)

Parameters:

ignorePermissions - the ignorePermissions to set

getMessage

public java.lang.String getMessage()

Returns:

the message

setMessage

public void setMessage(java.lang.String message)

Parameters:

message - the message to set

getComment

public java.lang.String getComment()

Returns:

the comment

setComment

public void setComment(java.lang.String comment)

Parameters:

comment - the comment to set

shouldIgnore

public boolean shouldIgnore(@Nullable
                            LocalPlayer player)

Returns true if this player should be ignored.

Parameters:

player - The player to check

Returns:

whether this player should be ignored for blacklist blocking

getActions

public java.util.List<Action> getActions(java.lang.Class<? extends BlacklistEvent> eventCls)

Get the associated actions with an event.

Parameters:

eventCls - The event's class

Returns:

The actions for the given event

check

public boolean check(boolean useAsWhitelist,
                     BlacklistEvent event,
                     boolean forceRepeat,
                     boolean silent)

Method to handle the event.

Parameters:

useAsWhitelist - Whether this entry is being used in a whitelist

event - The event to check

forceRepeat - Whether to force repeating notifications even within the delay limit

silent - Whether to prevent notifications from happening

Returns:

Whether the action was allowed