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 is a tool functionality extention module.
38   * This default implementation of interface {@link Plugin} functionality.
39   *
40   * @author <A href="mailto:demakov@ispras.ru">Alexey Demakov</A>
41   * @version $Id: PluginClass.java,v 1.2 2004/10/11 15:00:44 all-x Exp $
42   */
43  public abstract class PluginClass implements Plugin
44  {
45      /***
46       * {@inheritDoc}
47       */
48      public final String getName()
49      {
50          return name;
51      }
52  
53      /***
54       * {@inheritDoc}
55       */
56      public void init( PluginManager pm, String name )
57      {
58          this.pm = pm;
59          this.mbox = pm.getMessageBox();
60          this.name = name;
61      }
62  
63      /***
64       * {@inheritDoc}
65       */
66      public final Object getPlugin( String name )
67      {
68          return pm.getPlugin( name );
69      }
70  
71      /***
72       * {@inheritDoc}
73       */
74      public final String getPropertyName( String name )
75      {
76          return pm.getPluginPropertyName( this, name );
77      }
78  
79      /***
80       * {@inheritDoc}
81       */
82      public final String getProperty( String name )
83      {
84          return pm.getPluginProperty( this, name );
85      }
86  
87      /***
88       * {@inheritDoc}
89       */
90      public String getProperty( String name, String value )
91      {
92          return pm.getPluginProperty( this, name, value );
93      }
94  
95      /***
96       * Returns revision number from CVS tag #Revision#
97       *
98       * @param rev Revision string.
99       * @return    Revision number.
100      */
101     public static String getRevision( String rev )
102     {
103         return rev.substring( "$Revision: ".length(), rev.length() - 2 );
104     }
105 
106     /***
107      * {@inheritDoc}
108      */
109     public PluginManager getPluginManager()
110     {
111         return pm;
112     }
113 
114     //--------------------------------------------------------------------------
115     // implementation
116 
117     protected PluginManager pm;
118     protected MessageBox mbox;
119     protected String name;
120 }