Package me.remigio07.chatplugin.api.server.chat.antispam

Class DenyChatReason<H extends DenyChatReasonHandler>

java.lang.Object

me.remigio07.chatplugin.api.server.chat.antispam.DenyChatReason<H>

Type Parameters:

H - Reason's handler

public class DenyChatReason<H extends DenyChatReasonHandler>
extends Object

Represents the reason why a message may be prevented from being sent.

This class is a pseudo-Enum. It contains the following methods: name(), ordinal(), valueOf(String) and values().

Field Summary

Fields

Modifier and Type	Field	Description
static final DenyChatReason<ChatManager>	BLANK_MESSAGE	The message String.isEmpty() after stripping colors and removing spaces.
static final DenyChatReason<AntispamManager>	CAPS	The message AntispamManager.exceedsMaxCapsLength(String) and AntispamManager.exceedsMaxCapsPercentage(String) and the sender does not have the permission "chatplugin.antispam.caps" or "chatplugin.antispam.bypass".
static final DenyChatReason<AntispamManager>	FLOOD	The AntispamManager.getFloodCache() list contains the sender and they do not have the permission "chatplugin.antispam.flood" or "chatplugin.antispam.bypass".
static final DenyChatReason<FormattedChatManager>	FORMAT	When the message FormattedChatManager.containsFormattedText(String, List, boolean) and the sender does not have the permission "chatplugin.formatted-chat".
static final DenyChatReason<AntispamManager>	IP_ADDRESS	When the message AntispamManager.containsDisallowedIP(String) and the sender does not have the permission "chatplugin.antispam.bypass".
static final DenyChatReason<MuteManager>	MUTE	When the sender MuteManager.isMuted(OfflinePlayer, String).
static final DenyChatReason<ChatManager>	MUTEALL	When ChatManager.isChatMuted() == true.
static final DenyChatReason<AntispamManager>	SPAM	The AntispamManager.getSpamCache() map contains the sender and they do not have the permission "chatplugin.antispam.spam" or "chatplugin.antispam.bypass".
static final DenyChatReason<AntispamManager>	SWEAR	When the message AntispamManager.containsBlacklistedWord(String) and the sender does not have the permission "chatplugin.antispam.bypass".
static final DenyChatReason<AntispamManager>	URL	When the message AntispamManager.containsDisallowedURL(String) and the sender does not have the permission "chatplugin.antispam.bypass".
static final DenyChatReason<VanishManager>	VANISH	When the sender ChatPluginServerPlayer.isVanished().

Method Summary

Modifier and Type	Method	Description
Class<H>	getHandlerClass()	Gets this deny chat reason's handler's class.
String	getMessage(Language language)	Gets this deny chat reason's message translated for the specified language.
String	getMessagePath()	Gets this deny chat reason's message's path in the messages' files.
String	name()	Equivalent of Enum.name().
int	ordinal()	Equivalent of Enum.ordinal().
static DenyChatReason<?>	valueOf(String name)	Equivalent of Enum#valueOf(String), with the only difference that instead of throwing IllegalArgumentException null is returned if the constant's name is invalid.
static DenyChatReason<?>[]	values()	Equivalent of Enum#values().

Methods inherited from class java.lang.Object

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

Field Details

BLANK_MESSAGE

public static final DenyChatReason<ChatManager> BLANK_MESSAGE

The message String.isEmpty() after stripping colors and removing spaces.

Handler: ChatManager
Message path: "chat.no-blank-messages"

CAPS

public static final DenyChatReason<AntispamManager> CAPS

The message AntispamManager.exceedsMaxCapsLength(String) and AntispamManager.exceedsMaxCapsPercentage(String) and the sender does not have the permission "chatplugin.antispam.caps" or "chatplugin.antispam.bypass".

Handler: AntispamManager
Message path: "chat.antispam.no-caps"

FLOOD

public static final DenyChatReason<AntispamManager> FLOOD

The AntispamManager.getFloodCache() list contains the sender and they do not have the permission "chatplugin.antispam.flood" or "chatplugin.antispam.bypass".

Handler: AntispamManager
Message path: "chat.antispam.no-flood"

FORMAT

public static final DenyChatReason<FormattedChatManager> FORMAT

When the message FormattedChatManager.containsFormattedText(String, List, boolean) and the sender does not have the permission "chatplugin.formatted-chat".

Handler: FormattedChatManager
Message path: "chat.no-format"

IP_ADDRESS

public static final DenyChatReason<AntispamManager> IP_ADDRESS

When the message AntispamManager.containsDisallowedIP(String) and the sender does not have the permission "chatplugin.antispam.bypass".

Handler: AntispamManager
Message path: "chat.antispam.no-ip"

MUTE

public static final DenyChatReason<MuteManager> MUTE

When the sender MuteManager.isMuted(OfflinePlayer, String).

Handler: MuteManager
Message path: "mute.no-chat"

MUTEALL

public static final DenyChatReason<ChatManager> MUTEALL

When ChatManager.isChatMuted() == true.

Handler: ChatManager
Message path: "commands.muteall.muted"

SPAM

public static final DenyChatReason<AntispamManager> SPAM

The AntispamManager.getSpamCache() map contains the sender and they do not have the permission "chatplugin.antispam.spam" or "chatplugin.antispam.bypass".

Handler: AntispamManager
Message path: "chat.antispam.no-spam"

SWEAR

public static final DenyChatReason<AntispamManager> SWEAR

When the message AntispamManager.containsBlacklistedWord(String) and the sender does not have the permission "chatplugin.antispam.bypass".

Handler: AntispamManager
Message path: "chat.antispam.no-swear"

URL

public static final DenyChatReason<AntispamManager> URL

When the message AntispamManager.containsDisallowedURL(String) and the sender does not have the permission "chatplugin.antispam.bypass".

Handler: AntispamManager
Message path: "chat.antispam.no-url"

VANISH

public static final DenyChatReason<VanishManager> VANISH

When the sender ChatPluginServerPlayer.isVanished().

Handler: VanishManager
Message path: "vanish.no-chat"

Method Details

name

public String name()

Equivalent of Enum.name().

Returns:

Constant's name

ordinal

public int ordinal()

Equivalent of Enum.ordinal().

Returns:

Constant's ordinal

getMessagePath

public String getMessagePath()

Gets this deny chat reason's message's path in the messages' files.

Returns:

Reason's message's path

getMessage

public String getMessage(Language language)

Gets this deny chat reason's message translated for the specified language.

Parameters:

language - Language used to translate the message

Returns:

Translated message

getHandlerClass

public Class<H> getHandlerClass()

Gets this deny chat reason's handler's class.

Returns:

Reason's handler's class

valueOf

public static DenyChatReason<?> valueOf(String name)

Equivalent of Enum#valueOf(String), with the only difference that instead of throwing IllegalArgumentException null is returned if the constant's name is invalid.

Parameters:

name - Constant's name

Returns:

Enum constant

values

public static DenyChatReason<?>[] values()

Equivalent of Enum#values().

Returns:

Enum constants