IndependentModeler/src/cz/cvut/promod/services/pluginLoaderService/utils/PluginDetails.java

   1 package cz.cvut.promod.services.pluginLoaderService.utils;
   2
   3 import java.util.List;
   4 import java.util.LinkedList;
   5
   6 /**
   7  * ProMod, master thesis project
   8  * User: Petr Zverina, petr.zverina@gmail.com
   9  * Date: 22:50:27, 4.2.2010
  10  */
  11
  12 /**
  13  * Holds loaded info about the plugin(s) from the plugin configuration file.
  14  */
  15 public class PluginDetails{
  16
  17     private final String clazz;
  18
  19     private final String config;
  20
  21     private final String alias;
  22
  23     private final List<PluginDetails> modules;
  24
  25     /**
  26      * Constructs new PluginDetails object.
  27      *
  28      * @param clazz is the plugin's class ful qualified name
  29      * @param config is the plugin's configuration file
  30      * @param alias is the plugin's alias
  31      */
  32     public PluginDetails(final String clazz, final String config, final String alias) {
  33         this.clazz = clazz;
  34         this.config = config;
  35         this.alias = alias;
  36
  37         modules = new LinkedList<PluginDetails>();
  38     }
  39
  40     /**
  41      * Notations have it's modules, these modules are stored in list
  42      *
  43      * Do not use with extensions!
  44      *
  45      * @param pluginDetails is the plugin detail of the module
  46      */
  47     public void addPluginDetails(final PluginDetails pluginDetails){
  48         modules.add(pluginDetails);
  49     }
  50
  51     /**
  52      * Returns the full qualified class name.
  53      *
  54      * @return full qualified class name
  55      */
  56     public String getClazz() {
  57         return clazz;
  58     }
  59
  60     /**
  61      * Returns the plugin's configuration class.
  62      *
  63      * @return plugin's configuration file
  64      */
  65     public String getConfig() {
  66         return config;
  67     }
  68
  69     /**
  70      * Returns the plugin's alias.
  71      *
  72      * @return plugin's alias
  73      */
  74     public String getAlias() {
  75         return alias;
  76     }
  77
  78     /**
  79      * Returns all modules of the notation.
  80      *
  81      * Do not use with extensions!
  82      *
  83      * @return the list of notation's modules.
  84      */
  85     public List<PluginDetails> getModules() {
  86         return modules;
  87     }
  88
  89     /**
  90      * Pops loaded module = returns module in style FIFO
  91      *
  92      * Do not use with extensions.
  93      *
  94      * @return the most earlier loaded module in the list
  95      */
  96     public PluginDetails pop() {
  97         if(modules.size() != 0){
  98             return  modules.remove(0);
  99         }
 100
 101         return null;
 102     }
 103 }