com.threerings.crowd.chat.client

Class CurseFilter

java.lang.Object

com.threerings.crowd.chat.client.CurseFilter

All Implemented Interfaces:

ChatFilter

public abstract class CurseFilter
extends Object
implements ChatFilter

A chat filter that can filter out curse words from user chat.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CurseFilter.Mode Indicates how messages should be handled.

Constructor Summary

Constructors

Constructor and Description
CurseFilter(String curseWords, String stopWords) Creates a curse filter.

Method Summary

Modifier and Type	Method and Description
static String	comicChars(int length) Return a comicy replacement of the specified length.
String	filter(String msg, Name otherUser, boolean outgoing) Filter a chat message.
abstract CurseFilter.Mode	getFilterMode() The client will need to provide a way to look up our current chat filter mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

CurseFilter

public CurseFilter(String curseWords,
                   String stopWords)

Creates a curse filter. The curse words should be a string in the following format:

 *penis*=John_Thomas shit*=barnacle muff=britches
 

The key/value pairs are separated by spaces, * matches word characters and the value after the = is the string into which to convert the text when converting to the vernacular. Underscores in the target string will be turned into spaces.

And stopWords should be in the following format:

 *faggot* rape rapes raped raping
 

Words are separated by spaces and * matches any other word characters.

Method Detail

comicChars

public static String comicChars(int length)

Return a comicy replacement of the specified length.

getFilterMode

public abstract CurseFilter.Mode getFilterMode()

The client will need to provide a way to look up our current chat filter mode.

filter

public String filter(String msg,
                     Name otherUser,
                     boolean outgoing)

Description copied from interface: ChatFilter

Filter a chat message.

Specified by:

filter in interface ChatFilter

Parameters:

msg - the message text to be filtered.

otherUser - an optional argument that represents the target or the speaker, depending on 'outgoing', and can be considered in filtering if it is provided.

outgoing - true if the message is going out to the server.

Returns:

the filtered message, or null to block it completely.