View Javadoc

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