KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > opensymphony > webwork > interceptor > ParameterAware


1 /*
2  * Copyright (c) 2002-2003 by OpenSymphony
3  * All rights reserved.
4  */
5 /*
6  * WebWork, Web Application Framework
7  *
8  * Distributable under Apache license.
9  * See terms of license at opensource.org
10  */
11 package com.opensymphony.webwork.interceptor;
12
13 import java.util.Map JavaDoc;
14
15
16 /**
17  * This interface gives actions an alternative way of receiving input parameters. The map will
18  * contain all input parameters as name/value entries. Actions that need this should simply implement it. <p>
19  * <p/>
20  * One common use for this is to have the action propagate parameters to internally instantiated data
21  * objects. <p>
22  * <p/>
23  * Note that all parameter values for a given name will be returned, so the type of the objects in
24  * the map is <tt>java.lang.String[]</tt>.
25  *
26  * @author <a HREF="mailto:rickard@middleware-company.com">Rickard Öberg</a>
27  */
28 public interface ParameterAware {
29     //~ Methods ////////////////////////////////////////////////////////////////
30
31     /**
32      * Sets the map of input parameters in the implementing class.
33      *
34      * @param parameters a Map of parameters (name/value Strings).
35      */
36     public void setParameters(Map JavaDoc parameters);
37 }
38
Popular Tags