Package studio.thevipershow.safechat.api.checks

Class ChatCheck

java.lang.Object

studio.thevipershow.safechat.api.checks.ChatCheck

All Implemented Interfaces:

Check

Direct Known Subclasses:

AddressCheck, CapsCheck, FloodCheck, MessageTooLongCheck, RepetitionCheck, WordsBlacklistCheck

public abstract class ChatCheck
extends java.lang.Object
implements Check

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.regex.Pattern	DOMAIN_REGEX
static java.util.regex.Pattern	IPV4_REGEX
static java.lang.String	PLAYER_PLACEHOLDER
static java.lang.String	PREFIX_PLACEHOLDER
static java.util.regex.Pattern	SPLIT_SPACE

Constructor Summary

Constructors

Constructor	Description
ChatCheck()

Method Summary

Modifier and Type	Method	Description
@NotNull java.lang.String	getBypassPermission()	The permission that will make this check be skipped.
CheckPriority.Priority	getCheckPriority()	Get the priority of the check.
@NotNull java.lang.String	getName()	Get the name of this check.

Methods inherited from class java.lang.Object

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

Methods inherited from interface studio.thevipershow.safechat.api.checks.Check

check, getLoggingEnabled, getPunishmentCommand, getPunishmentRequiredValue, getWarningMessages, hasWarningEnabled, replacePlaceholders

Field Details

DOMAIN_REGEX

public static final java.util.regex.Pattern DOMAIN_REGEX

IPV4_REGEX

public static final java.util.regex.Pattern IPV4_REGEX

SPLIT_SPACE

public static final java.util.regex.Pattern SPLIT_SPACE

PLAYER_PLACEHOLDER

public static final java.lang.String PLAYER_PLACEHOLDER

See Also:

Constant Field Values

PREFIX_PLACEHOLDER

public static final java.lang.String PREFIX_PLACEHOLDER

See Also:

Constant Field Values

Constructor Details

ChatCheck

public ChatCheck()

Method Details

getName

@NotNull
public final @NotNull java.lang.String getName()

Description copied from interface: Check

Get the name of this check. Note: You can instead extend ChatCheck and use annotation CheckName on your check class and you won't need to define this method.

Specified by:

getName in interface Check

Returns:

The check's name.

getBypassPermission

@NotNull
public final @NotNull java.lang.String getBypassPermission()

Description copied from interface: Check

The permission that will make this check be skipped. A player with this permission will never be checked. This can be used CheckPermission

Specified by:

getBypassPermission in interface Check

Returns:

The permission.

getCheckPriority

@NotNull
public final CheckPriority.Priority getCheckPriority()

Description copied from interface: Check

Get the priority of the check. The priority of a check will influence the order of call of your check. Higher priority checks will get called before lower priority ones. If no annotation of type CheckPriority is present on the Check class, NORMAL priority will be used.

Specified by:

getCheckPriority in interface Check

Returns:

The priority of the check.