View Javadoc

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