View Javadoc

1   /*
2    * $Id: ParameterAware.java 418521 2006-07-01 23:36:50Z mrdon $
3    *
4    * Copyright 2006 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  package org.apache.struts2.interceptor;
19  
20  import java.util.Map;
21  
22  
23  /***
24   * This interface gives actions an alternative way of receiving input parameters. The map will
25   * contain all input parameters as name/value entries. Actions that need this should simply implement it. <p>
26   * <p/>
27   * One common use for this is to have the action propagate parameters to internally instantiated data
28   * objects. <p>
29   * <p/>
30   * Note that all parameter values for a given name will be returned, so the type of the objects in
31   * the map is <tt>java.lang.String[]</tt>.
32   *
33   */
34  public interface ParameterAware {
35  
36      /***
37       * Sets the  map of input parameters in the implementing class.
38       *
39       * @param parameters a Map of parameters (name/value Strings).
40       */
41      public void setParameters(Map parameters);
42  }