Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Constraint |
|
| 1.0;1 |
1 | package org.apache.fulcrum.intake.validator; | |
2 | ||
3 | /* | |
4 | * Licensed to the Apache Software Foundation (ASF) under one | |
5 | * or more contributor license agreements. See the NOTICE file | |
6 | * distributed with this work for additional information | |
7 | * regarding copyright ownership. The ASF licenses this file | |
8 | * to you under the Apache License, Version 2.0 (the | |
9 | * "License"); you may not use this file except in compliance | |
10 | * with the License. You may obtain a copy of the License at | |
11 | * | |
12 | * http://www.apache.org/licenses/LICENSE-2.0 | |
13 | * | |
14 | * Unless required by applicable law or agreed to in writing, | |
15 | * software distributed under the License is distributed on an | |
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
17 | * KIND, either express or implied. See the License for the | |
18 | * specific language governing permissions and limitations | |
19 | * under the License. | |
20 | */ | |
21 | ||
22 | /** | |
23 | * A constraint has a name and a value and an optional message. | |
24 | * The name/value pair will have meaning to a Validator and the | |
25 | * message will serve as an error message in the event the Validator | |
26 | * determines the constraint is violated. | |
27 | * example: | |
28 | * name="maxLength" | |
29 | * value="255" | |
30 | * message="Value cannot be longer than 255 characters." | |
31 | * | |
32 | * @author <a href="mailto:jmcnally@collab.net">John McNally</a> | |
33 | * @version $Id: Constraint.java 1771953 2016-11-29 20:29:12Z tv $ | |
34 | */ | |
35 | public interface Constraint | |
36 | { | |
37 | /** | |
38 | * Get the name of the constraint. | |
39 | * | |
40 | * @return the constraint name | |
41 | */ | |
42 | String getName(); | |
43 | ||
44 | /** | |
45 | * Get the value of the constraint. | |
46 | * | |
47 | * @return the constraint value | |
48 | */ | |
49 | String getValue(); | |
50 | ||
51 | /** | |
52 | * Get the error message. | |
53 | * | |
54 | * @return the constraint error message | |
55 | */ | |
56 | String getMessage(); | |
57 | } |