Coverage Report

Coverage Report - org.apache.commons.validator.routines.RegexValidator

Classes in this File

Line Coverage

Branch Coverage

Complexity

RegexValidator

100%

56/56

100%

42/42

4.75

 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
  * this work for additional information regarding copyright ownership.
  * The ASF licenses this file to You under the Apache License, Version 2.0
  * (the "License"); you may not use this file except in compliance with
  * the License.  You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.apache.commons.validator.routines;
 
 import java.io.Serializable;
 import java.util.regex.Pattern;
 import java.util.regex.Matcher;
 
 /**
  * <b>Regular Expression</b> validation (using JDK 1.4+ regex support).
  * <p>
  * Construct the validator either for a single regular expression or a set (array) of
  * regular expressions. By default validation is <i>case sensitive</i> but constructors
  * are provided to allow  <i>case in-sensitive</i> validation. For example to create
  * a validator which does <i>case in-sensitive</i> validation for a set of regular
  * expressions:
  * </p>
  * <pre>
  * <code>
  * String[] regexs = new String[] {...};
  * RegexValidator validator = new RegexValidator(regexs, false);
  * </code>
  * </pre>
  *
  * <ul>
  *   <li>Validate <code>true</code> or <code>false</code>:</li>
  *   <li>
  *     <ul>
  *       <li><code>boolean valid = validator.isValid(value);</code></li>
  *     </ul>
  *   </li>
  *   <li>Validate returning an aggregated String of the matched groups:</li>
  *   <li>
  *     <ul>
  *       <li><code>String result = validator.validate(value);</code></li>
  *     </ul>
  *   </li>
  *   <li>Validate returning the matched groups:</li>
  *   <li>
  *     <ul>
  *       <li><code>String[] result = validator.match(value);</code></li>
  *     </ul>
  *   </li>
  * </ul>
  *
  * <b>Note that patterns are matched against the entire input.</b>
  *
  * <p>
  * Cached instances pre-compile and re-use {@link Pattern}(s) - which according
  * to the {@link Pattern} API are safe to use in a multi-threaded environment.
  * </p>
  *
  * @version $Revision: 1739356 $
  * @since Validator 1.4
  */
 public class RegexValidator implements Serializable {
 
     private static final long serialVersionUID = -8832409930574867162L;
 
     private final Pattern[] patterns;
 
     /**
      * Construct a <i>case sensitive</i> validator for a single
      * regular expression.
      *
      * @param regex The regular expression this validator will
      * validate against
      */
     public RegexValidator(String regex) {
         this(regex, true);
     }
 
     /**
      * Construct a validator for a single regular expression
      * with the specified case sensitivity.
      *
      * @param regex The regular expression this validator will
      * validate against
      * @param caseSensitive when <code>true</code> matching is <i>case
      * sensitive</i>, otherwise matching is <i>case in-sensitive</i>
      */
     public RegexValidator(String regex, boolean caseSensitive) {
         this(new String[] {regex}, caseSensitive);
     }
 
     /**
      * Construct a <i>case sensitive</i> validator that matches any one
      * of the set of regular expressions.
      *
      * @param regexs The set of regular expressions this validator will
      * validate against
      */
     public RegexValidator(String[] regexs) {
         this(regexs, true);
     }
 
     /**
      * Construct a validator that matches any one of the set of regular
      * expressions with the specified case sensitivity.
      *
      * @param regexs The set of regular expressions this validator will
      * validate against
      * @param caseSensitive when <code>true</code> matching is <i>case
      * sensitive</i>, otherwise matching is <i>case in-sensitive</i>
      */
     public RegexValidator(String[] regexs, boolean caseSensitive) {
         if (regexs == null || regexs.length == 0) {
             throw new IllegalArgumentException("Regular expressions are missing");
         }
         patterns = new Pattern[regexs.length];
         int flags =  (caseSensitive ? 0: Pattern.CASE_INSENSITIVE);
         for (int i = 0; i < regexs.length; i++) {
             if (regexs[i] == null || regexs[i].length() == 0) {
                 throw new IllegalArgumentException("Regular expression[" + i + "] is missing");
             }
             patterns[i] =  Pattern.compile(regexs[i], flags);
         }
     }
 
     /**
      * Validate a value against the set of regular expressions.
      *
      * @param value The value to validate.
      * @return <code>true</code> if the value is valid
      * otherwise <code>false</code>.
      */
     public boolean isValid(String value) {
         if (value == null) {
             return false;
         }
         for (int i = 0; i < patterns.length; i++) {
             if (patterns[i].matcher(value).matches()) {
                 return true;
             }
         }
         return false;
     }
 
     /**
      * Validate a value against the set of regular expressions
      * returning the array of matched groups.
      *
      * @param value The value to validate.
      * @return String array of the <i>groups</i> matched if
      * valid or <code>null</code> if invalid
      */
     public String[] match(String value) {
         if (value == null) {
             return null;
         }
         for (int i = 0; i < patterns.length; i++) {
             Matcher matcher = patterns[i].matcher(value);
             if (matcher.matches()) {
                 int count = matcher.groupCount();
                 String[] groups = new String[count];
                 for (int j = 0; j < count; j++) {
                     groups[j] = matcher.group(j+1);
                 }
                 return groups;
             }
         }
         return null;
     }
 
 
     /**
      * Validate a value against the set of regular expressions
      * returning a String value of the aggregated groups.
      *
      * @param value The value to validate.
      * @return Aggregated String value comprised of the
      * <i>groups</i> matched if valid or <code>null</code> if invalid
      */
     public String validate(String value) {
         if (value == null) {
             return null;
         }
         for (int i = 0; i < patterns.length; i++) {
             Matcher matcher = patterns[i].matcher(value);
             if (matcher.matches()) {
                 int count = matcher.groupCount();
                 if (count == 1) {
                     return matcher.group(1);
                 }
                 StringBuilder buffer = new StringBuilder();
                 for (int j = 0; j < count; j++) {
                     String component = matcher.group(j+1);
                     if (component != null) {
                         buffer.append(component);
                     }
                 }
                 return buffer.toString();
             }
         }
         return null;
     }
 
     /**
      * Provide a String representation of this validator.
      * @return A String representation of this validator
      */
     @Override
     public String toString() {
         StringBuilder buffer = new StringBuilder();
         buffer.append("RegexValidator{");
         for (int i = 0; i < patterns.length; i++) {
             if (i > 0) {
                 buffer.append(",");
             }
             buffer.append(patterns[i].pattern());
         }
         buffer.append("}");
         return buffer.toString();
     }
 
 }

1		/*
2		* Licensed to the Apache Software Foundation (ASF) under one or more
3		* contributor license agreements. See the NOTICE file distributed with
4		* this work for additional information regarding copyright ownership.
5		* The ASF licenses this file to You under the Apache License, Version 2.0
6		* (the "License"); you may not use this file except in compliance with
7		* the License. You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17		package org.apache.commons.validator.routines;
18
19		import java.io.Serializable;
20		import java.util.regex.Pattern;
21		import java.util.regex.Matcher;
22
23		/**
24		* <b>Regular Expression</b> validation (using JDK 1.4+ regex support).
25		* <p>
26		* Construct the validator either for a single regular expression or a set (array) of
27		* regular expressions. By default validation is <i>case sensitive</i> but constructors
28		* are provided to allow <i>case in-sensitive</i> validation. For example to create
29		* a validator which does <i>case in-sensitive</i> validation for a set of regular
30		* expressions:
31		* </p>
32		* <pre>
33		* <code>
34		* String[] regexs = new String[] {...};
35		* RegexValidator validator = new RegexValidator(regexs, false);
36		* </code>
37		* </pre>
38		*
39		* <ul>
40		* <li>Validate <code>true</code> or <code>false</code>:</li>
41		* <li>
42		* <ul>
43		* <li><code>boolean valid = validator.isValid(value);</code></li>
44		* </ul>
45		* </li>
46		* <li>Validate returning an aggregated String of the matched groups:</li>
47		* <li>
48		* <ul>
49		* <li><code>String result = validator.validate(value);</code></li>
50		* </ul>
51		* </li>
52		* <li>Validate returning the matched groups:</li>
53		* <li>
54		* <ul>
55		* <li><code>String[] result = validator.match(value);</code></li>
56		* </ul>
57		* </li>
58		* </ul>
59		*
60		* <b>Note that patterns are matched against the entire input.</b>
61		*
62		* <p>
63		* Cached instances pre-compile and re-use {@link Pattern}(s) - which according
64		* to the {@link Pattern} API are safe to use in a multi-threaded environment.
65		* </p>
66		*
67		* @version $Revision: 1739356 $
68		* @since Validator 1.4
69		*/
70		public class RegexValidator implements Serializable {
71
72		private static final long serialVersionUID = -8832409930574867162L;
73
74		private final Pattern[] patterns;
75
76		/**
77		* Construct a <i>case sensitive</i> validator for a single
78		* regular expression.
79		*
80		* @param regex The regular expression this validator will
81		* validate against
82		*/
83		public RegexValidator(String regex) {
84	120	this(regex, true);
85	117	}
86
87		/**
88		* Construct a validator for a single regular expression
89		* with the specified case sensitivity.
90		*
91		* @param regex The regular expression this validator will
92		* validate against
93		* @param caseSensitive when <code>true</code> matching is <i>case
94		* sensitive</i>, otherwise matching is <i>case in-sensitive</i>
95		*/
96		public RegexValidator(String regex, boolean caseSensitive) {
97	124	this(new String[] {regex}, caseSensitive);
98	121	}
99
100		/**
101		* Construct a <i>case sensitive</i> validator that matches any one
102		* of the set of regular expressions.
103		*
104		* @param regexs The set of regular expressions this validator will
105		* validate against
106		*/
107		public RegexValidator(String[] regexs) {
108	9	this(regexs, true);
109	5	}
110
111		/**
112		* Construct a validator that matches any one of the set of regular
113		* expressions with the specified case sensitivity.
114		*
115		* @param regexs The set of regular expressions this validator will
116		* validate against
117		* @param caseSensitive when <code>true</code> matching is <i>case
118		* sensitive</i>, otherwise matching is <i>case in-sensitive</i>
119		*/
120	134	public RegexValidator(String[] regexs, boolean caseSensitive) {
121	134	if (regexs == null \|\| regexs.length == 0) {
122	2	throw new IllegalArgumentException("Regular expressions are missing");
123		}
124	132	patterns = new Pattern[regexs.length];
125	132	int flags = (caseSensitive ? 0: Pattern.CASE_INSENSITIVE);
126	274	for (int i = 0; i < regexs.length; i++) {
127	147	if (regexs[i] == null \|\| regexs[i].length() == 0) {
128	4	throw new IllegalArgumentException("Regular expression[" + i + "] is missing");
129		}
130	143	patterns[i] = Pattern.compile(regexs[i], flags);
131		}
132	127	}
133
134		/**
135		* Validate a value against the set of regular expressions.
136		*
137		* @param value The value to validate.
138		* @return <code>true</code> if the value is valid
139		* otherwise <code>false</code>.
140		*/
141		public boolean isValid(String value) {
142	50241	if (value == null) {
143	1	return false;
144		}
145	243774	for (int i = 0; i < patterns.length; i++) {
146	243672	if (patterns[i].matcher(value).matches()) {
147	50138	return true;
148		}
149		}
150	102	return false;
151		}
152
153		/**
154		* Validate a value against the set of regular expressions
155		* returning the array of matched groups.
156		*
157		* @param value The value to validate.
158		* @return String array of the <i>groups</i> matched if
159		* valid or <code>null</code> if invalid
160		*/
161		public String[] match(String value) {
162	120031	if (value == null) {
163	1	return null;
164		}
165	211095	for (int i = 0; i < patterns.length; i++) {
166	120036	Matcher matcher = patterns[i].matcher(value);
167	120036	if (matcher.matches()) {
168	28971	int count = matcher.groupCount();
169	28971	String[] groups = new String[count];
170	95469	for (int j = 0; j < count; j++) {
171	66498	groups[j] = matcher.group(j+1);
172		}
173	28971	return groups;
174		}
175		}
176	91059	return null;
177		}
178
179
180		/**
181		* Validate a value against the set of regular expressions
182		* returning a String value of the aggregated groups.
183		*
184		* @param value The value to validate.
185		* @return Aggregated String value comprised of the
186		* <i>groups</i> matched if valid or <code>null</code> if invalid
187		*/
188		public String validate(String value) {
189	570	if (value == null) {
190	1	return null;
191		}
192	1156	for (int i = 0; i < patterns.length; i++) {
193	855	Matcher matcher = patterns[i].matcher(value);
194	855	if (matcher.matches()) {
195	268	int count = matcher.groupCount();
196	268	if (count == 1) {
197	94	return matcher.group(1);
198		}
199	174	StringBuilder buffer = new StringBuilder();
200	820	for (int j = 0; j < count; j++) {
201	646	String component = matcher.group(j+1);
202	646	if (component != null) {
203	443	buffer.append(component);
204		}
205		}
206	174	return buffer.toString();
207		}
208		}
209	301	return null;
210		}
211
212		/**
213		* Provide a String representation of this validator.
214		* @return A String representation of this validator
215		*/
216		@Override
217		public String toString() {
218	6	StringBuilder buffer = new StringBuilder();
219	6	buffer.append("RegexValidator{");
220	13	for (int i = 0; i < patterns.length; i++) {
221	7	if (i > 0) {
222	1	buffer.append(",");
223		}
224	7	buffer.append(patterns[i].pattern());
225		}
226	6	buffer.append("}");
227	6	return buffer.toString();
228		}
229
230		}