Class RegexValidator
java.lang.Object
org.jenkinsci.remoting.org.apache.commons.validator.routines.RegexValidator
- All Implemented Interfaces:
Serializable
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class RegexValidator
extends Object
implements Serializable
Regular Expression validation (using JDK 1.4+ regex support).
Construct the validator either for a single regular expression or a set (array) of regular expressions. By default validation is case sensitive but constructors are provided to allow case in-sensitive validation. For example to create a validator which does case in-sensitive validation for a set of regular expressions:
String[] regexs = new String[] {...};
RegexValidator validator = new RegexValidator(regexs, false);
- Validate
true
orfalse
: -
boolean valid = validator.isValid(value);
- Validate returning an aggregated String of the matched groups:
-
String result = validator.validate(value);
- Validate returning the matched groups:
-
String[] result = validator.match(value);
Cached instances pre-compile and re-use Pattern
(s) - which according
to the Pattern
API are safe to use in a multi-threaded environment.
- Since:
- Validator 1.4
- Version:
- $Revision$
- See Also:
-
Constructor Summary
ConstructorDescriptionRegexValidator
(String regex) Construct a case sensitive validator for a single regular expression.RegexValidator
(String[] regexs) Construct a case sensitive validator that matches any one of the set of regular expressions.RegexValidator
(String[] regexs, boolean caseSensitive) Construct a validator that matches any one of the set of regular expressions with the specified case sensitivity.RegexValidator
(String regex, boolean caseSensitive) Construct a validator for a single regular expression with the specified case sensitivity. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Validate a value against the set of regular expressions.String[]
Validate a value against the set of regular expressions returning the array of matched groups.toString()
Provide a String representation of this validator.Validate a value against the set of regular expressions returning a String value of the aggregated groups.
-
Constructor Details
-
RegexValidator
Construct a case sensitive validator for a single regular expression.- Parameters:
regex
- The regular expression this validator will validate against
-
RegexValidator
Construct a validator for a single regular expression with the specified case sensitivity.- Parameters:
regex
- The regular expression this validator will validate againstcaseSensitive
- whentrue
matching is case sensitive, otherwise matching is case in-sensitive
-
RegexValidator
Construct a case sensitive validator that matches any one of the set of regular expressions.- Parameters:
regexs
- The set of regular expressions this validator will validate against
-
RegexValidator
Construct a validator that matches any one of the set of regular expressions with the specified case sensitivity.- Parameters:
regexs
- The set of regular expressions this validator will validate againstcaseSensitive
- whentrue
matching is case sensitive, otherwise matching is case in-sensitive
-
-
Method Details
-
isValid
Validate a value against the set of regular expressions.- Parameters:
value
- The value to validate.- Returns:
true
if the value is valid otherwisefalse
.
-
match
Validate a value against the set of regular expressions returning the array of matched groups.- Parameters:
value
- The value to validate.- Returns:
- String array of the groups matched if
valid or
null
if invalid
-
validate
Validate a value against the set of regular expressions returning a String value of the aggregated groups.- Parameters:
value
- The value to validate.- Returns:
- Aggregated String value comprised of the
groups matched if valid or
null
if invalid
-
toString
Provide a String representation of this validator.
-