Package org.deltava.discord

Class ContentFilter

java.lang.Object

org.deltava.discord.ContentFilter

class ContentFilter
extends Object

A Content filter for Discord messages.

Since:

11.0

Version:

11.1

Author:

Luke, Danielw

Constructor Summary

Constructors

Constructor	Description
ContentFilter()

Method Summary

Modifier and Type	Method	Description
boolean	add(String keyword, boolean isSafe)	Adds a word to the content filter.
boolean	delete(String keyword, boolean isSafe)	Removes a word from the content filter.
Collection<String>	getKeywords()	Returns all keywords.
Collection<String>	getSafewords()	Returns all accepted keywords.
void	init(Collection<String> kw, Collection<String> sw)	Initializes the content filter.
FilterResults	search(String msg)	Searches a message for prohibited or accepted keywords.

Methods inherited from class java.lang.Object

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

Constructor Details

ContentFilter

ContentFilter()

Method Details

init

public void init(Collection<String> kw,
 Collection<String> sw)

Initializes the content filter.

Parameters:

kw - a Collection of keywords to trigger on

sw - a Collection of safe keywords to ignore

add

public boolean add(String keyword,
 boolean isSafe)

Adds a word to the content filter.

Parameters:

keyword - the keyword

isSafe - TRUE if an accepted word, otherwise FALSE

Returns:

TRUE if the word was not present and added, otherwise FALSE

delete

public boolean delete(String keyword,
 boolean isSafe)

Removes a word from the content filter.

Parameters:

keyword - the keyword

isSafe - TRUE if an accepted word, otherwise FALSE

Returns:

TRUE if the word was present and removed, otherwise FALSE

getKeywords

public Collection<String> getKeywords()

Returns all keywords.

Returns:

a Collection of keywords

getSafewords

public Collection<String> getSafewords()

Returns all accepted keywords.

Returns:

a Collection of accepted keywords

search

public FilterResults search(String msg)

Searches a message for prohibited or accepted keywords.

Parameters:

msg - the message

Returns:

a FilterResults bean