View Javadoc

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