configurable.java

一个用于java web页面开发的开源包

package org.apache.velocity.tools.view.tools;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.util.Map;

/**
 * Interface for tools that can be passed configuration parameters.
 *
 * @author Nathan Bubna
 * @version $Id: Configurable.java 479724 2006-11-27 18:49:37Z nbubna $
 * @since VelocityTools 1.2
 * @deprecated Your tools now only need to have a configure(Map) method.
 */
public interface Configurable
{

    /**
     * Configures this tool using the specified parameters. The
     * map of parameters passed in is guaranteed not to be null.
     * If there are no parameters specified for this tool in your
     * toolbox definition, then this method will NOT be called at all.
     *
     * @param parameters the configuration data for this tool
     */
    public void configure(Map parameters);

}