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  import java.util.Map;
20  
21  /***
22   * This interface marks a bean/class that can have its properties set
23   * by values in a Map.
24   *
25   * @author <a href="mailto:jmcnally@collab.net">John McNally</a>
26   * @version $Id: InitableByConstraintMap.java 264148 2005-08-29 14:21:04Z henning $
27   */
28  public interface InitableByConstraintMap
29  {
30      /***
31       * Extract the relevant parameters from the constraints listed
32       * in <input-param> tags within the intake.xml file.
33       *
34       * @param inputParameters a <code>Map</code> of <code>Constraint</code>'s
35       * containing rules and error messages.
36       * @exception InvalidMaskException one of the mask rules is invalid
37       */
38      void init(Map inputParameters)
39              throws InvalidMaskException;
40  }