1 /**
2 The contents of this file are subject to the Mozilla Public License Version 1.1
3 (the "License"); you may not use this file except in compliance with the License.
4 You may obtain a copy of the License at http://www.mozilla.org/MPL/
5 Software distributed under the License is distributed on an "AS IS" basis,
6 WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
7 specific language governing rights and limitations under the License.
8
9 The Original Code is "PrimitiveTypeRule.java". Description:
10 "A rule that applies to a primitive datatype. "
11
12 The Initial Developer of the Original Code is University Health Network. Copyright (C)
13 2002. All Rights Reserved.
14
15 Contributor(s): ______________________________________.
16
17 Alternatively, the contents of this file may be used under the terms of the
18 GNU General Public License (the "GPL"), in which case the provisions of the GPL are
19 applicable instead of those above. If you wish to allow use of your version of this
20 file only under the terms of the GPL and not to allow others to use your version
21 of this file under the MPL, indicate your decision by deleting the provisions above
22 and replace them with the notice and other provisions required by the GPL License.
23 If you do not delete the provisions above, a recipient may use your version of
24 this file under either the MPL or the GPL.
25 */
26
27 package ca.uhn.hl7v2.validation;
28
29 /**
30 * A rule that applies to a primitive datatype.
31 * @author Bryan Tripp
32 */
33 public interface PrimitiveTypeRule extends Rule<String> {
34
35 /**
36 * Optionally performs an automatic correction on given data to make it
37 * conform (eg trims leading whitespace). This is to be called prior to
38 * test(). If no corrections are performed, the original value is returned.
39 *
40 * @param value an original value to be corrected
41 * @return a corrected version of the given value
42 */
43 String correct(String value);
44
45 /**
46 * Tests the given string against the criteria defined by this
47 * rule -- returns true if it passes the test, false otherwise.
48 *
49 * @deprecated use {@link #apply(Object)}
50 */
51 boolean test(String value);
52
53 }