Package ua.mcchickenstudio.opencreative.settings.filters

Class Filter

java.lang.Object

ua.mcchickenstudio.opencreative.settings.filters.Filter

public final class Filter
extends Object

Filter

This class represents a filter, that checks messages for violating some rules.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Filter.Context	This enum represents a context of place where filter was called.

Constructor Summary

Constructors

Constructor	Description
Filter()

Method Summary

Modifier and Type	Method	Description
void	addRule(@NotNull FilterRule rule)	Registers filter rule.
void	addWhitelist(@NotNull Pattern pattern)	Adds pattern to whitelist.
@NotNull FilterResult	checkContent(@NotNull String text, @NotNull Filter.Context context)	Checks specified text in context and returns a check result.
void	clearRules()	Clears all filter rules.
static @NotNull Filter	getInstance()	Returns instance of filter.
@NotNull List<Pattern>	getWhitelistPatterns()	Returns list of whitelist regex patterns.

Methods inherited from class java.lang.Object

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

Constructor Details

Filter

public Filter()

Method Details

getInstance

@NotNull
public static @NotNull Filter getInstance()

Returns instance of filter.

Returns:

instance of filter.

checkContent

@NotNull
public @NotNull FilterResult checkContent(@NotNull
 @NotNull String text,
 @NotNull
 @NotNull Filter.Context context)

Checks specified text in context and returns a check result.

Parameters:

text - text to check.

context - context of check.

Returns:

a filter result.

getWhitelistPatterns

@NotNull
public @NotNull List<Pattern> getWhitelistPatterns()

Returns list of whitelist regex patterns.

Returns:

whitelist patterns.

addWhitelist

public void addWhitelist(@NotNull
 @NotNull Pattern pattern)

Adds pattern to whitelist.

Parameters:

pattern - pattern to add.

addRule

public void addRule(@NotNull
 @NotNull FilterRule rule)

Registers filter rule.

Parameters:

rule - rule to add.

clearRules

public void clearRules()

Clears all filter rules.