xdev.util

Interface StringFilterClient

public interface StringFilterClient

The super class of all StringFilter clients.

The StringFilter of a instance will be applied in the order they were added.

Since:

3.0

Author:

XDEV Software (RHHF)

Method Summary

Modifier and Type	Method and Description
void	addStringFilter(StringFilter stringFilter) Adds an StringFilter to the instance.
StringFilter[]	getStringFilters() Returns an array of all the StringFilters added to this instance with addStringFilter(StringFilter).
StringFilter	removeStringFilter(StringFilter stringFilter) Removes an StringFilter from the instance.

Method Detail

addStringFilter

void addStringFilter(StringFilter stringFilter)

Adds an StringFilter to the instance.

The StringFilter of a instance will be applied in the order they were added.

Parameters:

stringFilter - the StringFilter to be added.

removeStringFilter

StringFilter removeStringFilter(StringFilter stringFilter)

Removes an StringFilter from the instance.

Parameters:

stringFilter - StringFilter to be removed.

Returns:

if the provided StringFilter was present, the removed StringFilter ; otherwise the StringFilter.NullStringFilter.NULL_STRING_FILTER instance. Never returns null.

getStringFilters

StringFilter[] getStringFilters()

Returns an array of all the StringFilters added to this instance with addStringFilter(StringFilter).

Returns:

all of the StringFilters added or an empty array if no filters have been added