KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > velocity > tools > view > ToolboxManager


1 /*
2  * Copyright 2003 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17
18 package org.apache.velocity.tools.view;
19
20
21 import org.apache.velocity.tools.view.context.ToolboxContext;
22
23
24 /**
25  * Common interface for toolbox manager implementations.
26  *
27  * @author <a HREF="mailto:nathan@esha.com">Nathan Bubna</a>
28  * @author <a HREF="mailto:geirm@apache.org">Geir Magnusson Jr.</a>
29  * @author <a HREF="mailto:sidler@teamup.com">Gabe Sidler</a>
30  *
31  * @version $Id: ToolboxManager.java,v 1.3 2004/02/18 20:08:29 nbubna Exp $
32  */
33 public interface ToolboxManager
34 {
35
36
37     /**
38      * Adds a tool to be managed
39      */
40     void addTool(ToolInfo info);
41
42
43     /**
44      * Creates a {@link ToolboxContext} from the tools and data
45      * in this manager. Tools that implement the ViewTool
46      * interface should be initialized using the given initData.
47      *
48      * @param initData data used to initialize ViewTools
49      * @return the created ToolboxContext
50      */
51     ToolboxContext getToolboxContext(Object JavaDoc initData);
52
53
54 }
55
Popular Tags