View Javadoc

1   // %1897510634:hoplugins%
2   package hoplugins;
3   
4   import plugins.IHOMiniModel;
5   import plugins.ILib;
6   import plugins.IOfficialPlugin;
7   
8   import java.io.File;
9   
10  
11  /***
12   * Common Utility Plugin
13   *
14   * @author <a href=mailto:draghetto@users.sourceforge.net>Massimiliano Amato</a>
15   */
16  public class Commons implements ILib, IOfficialPlugin {
17      //~ Static fields/initializers -----------------------------------------------------------------
18  
19      /*** HO Model Reference */
20      private static IHOMiniModel model;
21  
22      /*** Plugin version identifier */
23      private static final double PLUGIN_VERSION = 1.04d;
24  
25      /*** TODO Missing Parameter Documentation */
26      private static final String PLUGIN_NAME = "Commons";
27  
28      //~ Methods ------------------------------------------------------------------------------------
29  
30      /***
31       * Gets the HO data model
32       *
33       * @return IHOMiniModel instance
34       */
35      public static IHOMiniModel getModel() {
36          return model;
37      }
38  
39      /***
40       * Return a name
41       *
42       * @return the name
43       */
44      public final String getName() {
45          return PLUGIN_NAME + " " + PLUGIN_VERSION;
46      }
47  
48      /***
49       * Returns the PluginId
50       *
51       * @return the plugin id
52       */
53      public final int getPluginID() {
54          return 24;
55      }
56  
57      /***
58       * Returns the plugin name
59       *
60       * @return the plugin name
61       */
62      public final String getPluginName() {
63          return PLUGIN_NAME + " Library";
64      }
65  
66      /***
67       * {@inheritDoc}
68       */
69      public final File[] getUnquenchableFiles() {
70          return null;
71      }
72  
73      /***
74       * {@inheritDoc}
75       */
76      public final double getVersion() {
77          return PLUGIN_VERSION;
78      }
79  
80      /***
81       * {@inheritDoc}
82       */
83      public final void start(IHOMiniModel hoModel) {
84          model = hoModel;
85      }
86  }