View Javadoc

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