Package com.chillycheesy.modulo.modules

Class ModuleConfig

java.lang.Object
com.chillycheesy.modulo.modules.ModuleConfig
public class ModuleConfig extends Object
Represent the configuration of a module.
The attributes are made to be the same you put in your module.xml file (see ModuleBuilder for details)

  • Field Details

    • DEFAULT_MAIN_PAGE_NAME

      public static final String DEFAULT_MAIN_PAGE_NAME
      The default name of the main page, by defaul it's set to "index"
      See Also:
      Constant Field Values

  • Constructor Details

    • ModuleConfig

      public ModuleConfig​(String name, String version, List<String> authors, List<String> dependencies, List<String> softDependencies, String main)
      Parameters:
      name - it's how your HTModule will be call by HomeTracker
      note that two HTModules can't have the same name (you won't be able to add it to the ModuleManager
      version - the actual version of your module
      authors - the list of persons that works on your module
      dependencies - the list of modules that your module need to work, the dependencies will be load before your module get load by the ModuleLoader (your module cannot load without them)
      softDependencies - the list of modules that your module can use to work with but without being an obligation (your module can load without them)
      main - the main file of your jar (example: com.dev.MyAwesomeModule)

    • ModuleConfig

      public ModuleConfig​(ModuleConfig config)

    • ModuleConfig

      public ModuleConfig()

  • Method Details

    • getName

      public String getName()

    • setName

      public void setName​(String name)

    • getVersion

      public String getVersion()

    • setVersion

      public void setVersion​(String version)

    • getAuthors

      public List<String> getAuthors()
      Returns:
      the list of persons that work on this module

    • setAuthors

      public void setAuthors​(List<String> authors)

    • getDependencies

      public List<String> getDependencies()

    • setDependencies

      public void setDependencies​(List<String> dependencies)

    • getSoftDependencies

      public List<String> getSoftDependencies()

    • setSoftDependencies

      public void setSoftDependencies​(List<String> softDependencies)

    • getMain

      public String getMain()
      Returns:
      the path of the main file in the jar of this module

    • setMain

      public void setMain​(String main)

    • equals

      public boolean equals​(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object