org.mentawai.rule

Class ContainsRule

java.lang.Object

org.mentawai.rule.BasicRule

org.mentawai.rule.ContainsRule

All Implemented Interfaces:

Rule

public class ContainsRule
extends BasicRule

A validation rule that checks for words.

Author:

Sergio Oliveira

Constructor Summary

Constructors

Constructor and Description
ContainsRule(String... words) Creates a ContainsRule that checks for words.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	check(String value) Check a single input value from this action.
static ContainsRule	getInstance(String... words)
Map<String,String>	getTokens() Returns a map with tokens that can be used in the error messages.

Methods inherited from class org.mentawai.rule.BasicRule

check

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainsRule

public ContainsRule(String... words)

Creates a ContainsRule that checks for words.

Parameters:

words - The words to check

Method Detail

getInstance

public static ContainsRule getInstance(String... words)

getTokens

public Map<String,String> getTokens()

Description copied from interface: Rule

Returns a map with tokens that can be used in the error messages. The tokens in the error messages will be replaced by the token values in this map.

Specified by:

getTokens in interface Rule

Overrides:

getTokens in class BasicRule

Returns:

A map with the token values.

check

public boolean check(String value)

Description copied from class: BasicRule

Check a single input value from this action. Override this method to implement a basic rule for validation.

Specified by:

check in class BasicRule

Parameters:

value - The value to validate.

Returns:

true if the validation was successful.