edu.neu.ccs.filter
Class CaseActionFilter

java.lang.Object
  edu.neu.ccs.filter.CaseActionFilter

All Implemented Interfaces:

Cloneable, Serializable, StringableFilter

public class CaseActionFilter

extends Object

implements StringableFilter, Cloneable, Serializable

Filter used for modification of XString objects, in order to change case, restrict particular character codes, &c.

Since:

1.0

Version:

2.2

See Also:

Serialized Form

Field Summary

static CaseActionFilter	LOWER_CASE Case action filter that transforms XString data to all lower case characters.
static CaseActionFilter	TITLE_CASE Case action filter that transforms XString data to all title case characters.
static CaseActionFilter	UPPER_CASE Case action filter that transforms XString data to all upper case characters.

Constructor Summary

CaseActionFilter()

Method Summary

Stringable

filterStringable(Stringable obj) Filters the given XString object based on this case action scheme.

Methods inherited from class java.lang.Object

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

Field Detail

UPPER_CASE

public static final CaseActionFilter UPPER_CASE

Case action filter that transforms XString data to all upper case characters.

LOWER_CASE

public static final CaseActionFilter LOWER_CASE

Case action filter that transforms XString data to all lower case characters.

TITLE_CASE

public static final CaseActionFilter TITLE_CASE

Case action filter that transforms XString data to all title case characters. This case action changes all words to title case; words like "the", "a", and "and" are changed as well.

Constructor Detail

CaseActionFilter

public CaseActionFilter()

Method Detail

filterStringable

public Stringable filterStringable(Stringable obj)
                            throws FilterException

Filters the given XString object based on this case action scheme.

Specified by:

filterStringable in interface StringableFilter

Parameters:

obj - the object to be filtered

Throws:

FilterException - if the object is not an XString object