01: /*
02: * $Id: ParameterAware.java 471756 2006-11-06 15:01:43Z husted $
03: *
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "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: package org.apache.struts2.interceptor;
22:
23: import java.util.Map;
24:
25: /**
26: * This interface gives actions an alternative way of receiving input parameters. The map will
27: * contain all input parameters as name/value entries. Actions that need this should simply implement it. <p>
28: * <p/>
29: * One common use for this is to have the action propagate parameters to internally instantiated data
30: * objects. <p>
31: * <p/>
32: * Note that all parameter values for a given name will be returned, so the type of the objects in
33: * the map is <tt>java.lang.String[]</tt>.
34: *
35: */
36: public interface ParameterAware {
37:
38: /**
39: * Sets the map of input parameters in the implementing class.
40: *
41: * @param parameters a Map of parameters (name/value Strings).
42: */
43: public void setParameters(Map parameters);
44: }
|