Package com.simsilica.lemur.text

Class TextFilters

java.lang.Object

com.simsilica.lemur.text.TextFilters

public class TextFilters
extends Object

A collection of convenience filters for input and output.

Constructor Summary

Constructors

Constructor	Description
TextFilters()

Method Summary

Modifier and Type	Method	Description
static Function<Character,Character>	alpha()	A character filter that only allows numeric digits.
static Function<Character,Character>	alphaNumeric()	A character filter that only allows numeric digits.
static Function<Character,Character>	charFilter(Predicate<Character> predicate)	A character filter that skips characters that do not pass the specified predicate.
static Function<String,String>	charOutputTransform(Function<Character,Character> transform)	A text output transform that passes all characters through a character filter when passing them to the output string.
static Function<String,String>	constantTransform(char c)	A text output transform that replaces all characters in the string (including non-line feed whitespace) with the specified character.
static Predicate<Character>	isDigit()	Returns a predicate that returns true for numeric digit characters as is passed to Character.isDigit().
static Predicate<Character>	isInChars(char... chars)	Returns a predicate that returns true for any character in the specified list of characters.
static Predicate<Character>	isLetter()	Returns a predicate that returns true for letter characters as is passed to Character.isLetter().
static Predicate<Character>	isLetterOrDigit()	Returns a predicate that returns true for alpha or numeric characters is in Character.isLetterOrDigit().
static Function<String,String>	lowerCaseTransform()	A text output transform that converts all characters to lower case in the output string.
static Function<Character,Character>	numeric()	A character filter that only allows numeric digits.
static Function<Character,Character>	toLowerCase()	A character filter that converts all passed characters to upper case using Character.toUpperCase().
static Function<Character,Character>	toUpperCase()	A character filter that converts all passed characters to upper case using Character.toUpperCase().
static Function<String,String>	upperCaseTransform()	A text output transform that converts all characters to upper case in the output string.

Methods inherited from class java.lang.Object

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

Constructor Details

TextFilters

public TextFilters()

Method Details

constantTransform

public static Function<String,String> constantTransform(char c)

A text output transform that replaces all characters in the string (including non-line feed whitespace) with the specified character. This is useful for fields that must obscure the real data like password fields.

upperCaseTransform

public static Function<String,String> upperCaseTransform()

A text output transform that converts all characters to upper case in the output string.

lowerCaseTransform

public static Function<String,String> lowerCaseTransform()

A text output transform that converts all characters to lower case in the output string.

charOutputTransform

public static Function<String,String> charOutputTransform(Function<Character,Character> transform)

A text output transform that passes all characters through a character filter when passing them to the output string. Note: any character filters that skip characters will cause the standard DocumentModelFilter carat position to be inaccruate... ie: the user will see their cursor in the wrong place. For standard DocumentModelFilter usage, make sure the supplied filter always returns something for every character.

alpha

public static Function<Character,Character> alpha()

A character filter that only allows numeric digits.

numeric

public static Function<Character,Character> numeric()

A character filter that only allows numeric digits.

alphaNumeric

public static Function<Character,Character> alphaNumeric()

A character filter that only allows numeric digits.

charFilter

public static Function<Character,Character> charFilter(Predicate<Character> predicate)

A character filter that skips characters that do not pass the specified predicate.

toUpperCase

public static Function<Character,Character> toUpperCase()

A character filter that converts all passed characters to upper case using Character.toUpperCase().

toLowerCase

public static Function<Character,Character> toLowerCase()

A character filter that converts all passed characters to upper case using Character.toUpperCase().

isLetter

public static Predicate<Character> isLetter()

Returns a predicate that returns true for letter characters as is passed to Character.isLetter().

isDigit

public static Predicate<Character> isDigit()

Returns a predicate that returns true for numeric digit characters as is passed to Character.isDigit().

isLetterOrDigit

public static Predicate<Character> isLetterOrDigit()

Returns a predicate that returns true for alpha or numeric characters is in Character.isLetterOrDigit().

isInChars

public static Predicate<Character> isInChars(char... chars)

Returns a predicate that returns true for any character in the specified list of characters.