View Javadoc

1   package org.apache.velocity.tools.view;
2   
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  import java.util.Map;
23  
24  /**
25   * Common interface for toolbox manager implementations.
26   *
27   * @author Nathan Bubna
28   * @author <a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a>
29   * @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>
30   * @author <a href="mailto:henning@schmiedehausen.org">Henning P. Schmiedehausen</a>
31   * @version $Id: ToolboxManager.java 651470 2008-04-25 00:47:52Z nbubna $
32   */
33  @Deprecated
34  public interface ToolboxManager
35  {
36  
37      /**
38       * Adds a tool to be managed
39       */
40      void addTool(ToolInfo info);
41  
42      /**
43       * Adds a data object for the context.
44       *
45       * @param info An object that implements ToolInfo
46       */
47      void addData(ToolInfo info);
48  
49      /**
50       * Retrieves a map of the tools and data being managed. Tools
51       * that have an init(Object) method will be (re)initialized
52       * using the specified initData.
53       *
54       * @param initData data used to initialize tools
55       * @return the created ToolboxContext
56       * @since VelocityTools 1.2
57       */
58      Map getToolbox(Object initData);
59  
60  }