View Javadoc

1   /*
2    * Copyright (c) 2001-2004,
3    * RedVerst Group, ISP RAS http://www.ispras.ru
4    * All rights reserved.
5    *
6    * Redistribution and use in source and binary forms, with or without
7    * modification, are permitted provided that the following conditions are met:
8    *
9    * 1. Redistributions of source code must retain the above copyright notice, this
10   *    list of conditions and the following disclaimer.
11   *
12   * 2. Redistributions in binary form must reproduce the above copyright notice,
13   *    this list of conditions and the following disclaimer in the documentation
14   *    and/or other materials provided with the distribution.
15   *
16   * 3. The names "ATP", "TreeDL", "RedVerst", "ISP RAS"
17   *    may not be used to endorse or promote products derived from this software
18   *    without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
21   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22   * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
24   * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
27   * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29   * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30   */
31  
32  package com.unitesk.atp.tool;
33  
34  import com.unitesk.atp.messages.MessageBox;
35  
36  /***
37   * Plugin manager interface.
38   *
39   * @author <A href="mailto:demakov@ispras.ru">Alexey Demakov</A>
40   * @version $Id: PluginManager.java,v 1.1 2004/10/09 06:43:21 all-x Exp $
41   */
42  public interface PluginManager
43  {
44      /***
45       * Get plugin manager name.
46       */
47      String getName();
48  
49      /***
50       * Returns message box.
51       */
52      MessageBox getMessageBox();
53  
54      /***
55       * Returns the plugin with the specified name.
56       *
57       * @param  name    The plugin name.
58       * @return         The plugin with the specified name or <code>null</code>.
59       */
60      Object getPlugin( String name );
61  
62      /***
63       * Gets the qualified property name for plugin property name
64       * of the specified plugin.
65       *
66       * @param  plugin  The specified plugin.
67       * @param  name    The name of <code>plugin</code> property.
68       * @return         The corresponding qualified property name.
69       *                 For plugin property <code>property.name</code>
70       *                 of plugin with name <code>plugin</code>
71       *                 of manager <code>manager</code>
72       *                 qualified property name is
73       *                 <code>manager.plugin.property.name</code>.
74       *
75       * @throws IllegalArgumentException
76       *                 If <code>plugin</code> is not a plugin of this manager.
77       *
78       * @see    DynamicVariablesTable#getPropertyName(Object,String)
79       */
80      String getPluginPropertyName( Object plugin, String name );
81  
82      /***
83       * Gets the value of a plugin property with the specified name
84       * for the specified plugin.
85       *
86       * @param  plugin  The specified plugin.
87       * @param  name    The name of <code>plugin</code> property.
88       * @return         The value of the plugin property
89       *                 for the specified plugin.
90       * @throws IllegalArgumentException
91       *                 If <code>plugin</code> is not a plugin of this manager.
92       * @see    DynamicVariablesTable#getProperty(Object,String)
93       */
94      String getPluginProperty( Object plugin, String name );
95  
96      /***
97       * Gets the value of a plugin property with the specified name
98       * for the specified plugin
99       * or default value if this property is not defined.
100      *
101      * @param  plugin  The specified plugin.
102      * @param  name    The name of <code>plugin</code> property.
103      * @param  value   The default value is used if for the specified plugin
104      *                 there is no property with the specified name.
105      * @return         The value of the plugin property
106      *                 for the specified plugin.
107      * @throws IllegalArgumentException
108      *                 If <code>plugin</code> is not a plugin of this manager.
109      * @see    DynamicVariablesTable#getProperty(Object,String,String)
110      */
111     String getPluginProperty( Object plugin, String name, String value );
112 }