Module (CloudNet-Module 2.1.17 API)

java.lang.Object
- de.dytanic.cloudnet.event.EventKey
- - de.dytanic.cloudnet.modules.Module<E>

public abstract class Module<E>
extends EventKey

Data class for modules

Field Summary

Fields
Modifier and Type	Field and Description
`private ModuleClassLoader`	`classLoader`
`private File`	`configFile` The configuration file of this module.
`private Configuration`	`configuration` The configuration for this module.
`private File`	`dataFolder` The folder where the data of this module is saved in.
`private ModuleConfig`	`moduleConfig` The configuration of this module's file.
`private ModuleLoader`	`moduleLoader` The loader that was used to load this module.
`private File`	`utilFile` The utility file of this module.

Constructor Summary

Constructors
Constructor and Description

Module()

Constructors
Constructor and Description
`Module()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Module<E>`	`createUtils(Document document)` Creates a new utility file holding the information in the given document.
`boolean`	`equals(Object o)`
`String`	`getAuthor()` Returns the author of this module.
`ModuleClassLoader`	`getClassLoader()`
`abstract E`	`getCloud()` Returns the domain of this module.
`Configuration`	`getConfig()` Returns the currently loaded configuration; loads it, if it isn't loaded already.
`File`	`getConfigFile()`
`Configuration`	`getConfiguration()`
`File`	`getDataFolder()` Returns the directory where the data of this module is stored.
`ModuleConfig`	`getModuleConfig()`
`ModuleLoader`	`getModuleLoader()`
`String`	`getName()` Returns the name of the module, if a module configuration is present.
`String`	`getPluginName()` Returns the name of this module.
`File`	`getUtilFile()`
`Document`	`getUtils()` Loads and returns the document containing utility information.
`String`	`getVersion()` Returns the version of this module.
`int`	`hashCode()`
`Module<E>`	`loadConfig()` Load this module's configuration
`private void`	`loadConfiguration()`
`void`	`onBootstrap()` Method that is called when the module is enabled.
`void`	`onLoad()` Method that is called when the module is loaded.
`void`	`onShutdown()` Method that is called when the plugin is about to be shut down.
`Module<E>`	`saveConfig()` Save the configuration of this module.
`Module<E>`	`saveUtils(Document document)` Save the utility information.
`void`	`setClassLoader(ModuleClassLoader classLoader)`
`void`	`setConfigFile(File configFile)`
`void`	`setConfiguration(Configuration configuration)`
`void`	`setDataFolder(File dataFolder)`
`void`	`setModuleConfig(ModuleConfig moduleConfig)`
`void`	`setModuleLoader(ModuleLoader moduleLoader)`
`void`	`setUtilFile(File utilFile)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - dataFolder
```
private File dataFolder
```
    The folder where the data of this module is saved in.
  - configFile
```
private File configFile
```
    The configuration file of this module.
  - utilFile
```
private File utilFile
```
    The utility file of this module.
  - moduleConfig
```
private ModuleConfig moduleConfig
```
    The configuration of this module's file.
  - classLoader
```
private ModuleClassLoader classLoader
```
  - configuration
```
private Configuration configuration
```
    The configuration for this module.
  - moduleLoader
```
private ModuleLoader moduleLoader
```
    The loader that was used to load this module.
- Constructor Detail
  - Module
```
public Module()
```
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - onLoad
```
public void onLoad()
```
    Method that is called when the module is loaded.
  - onBootstrap
```
public void onBootstrap()
```
    Method that is called when the module is enabled.
  - onShutdown
```
public void onShutdown()
```
    Method that is called when the plugin is about to be shut down.
  - getName
```
public String getName()
```
    Returns the name of the module, if a module configuration is present.
    
    Returns:
    
    the name of the module if a module configuration is present, some_plugin- + a random long value otherwise.
  - getPluginName
```
public String getPluginName()
```
    Returns the name of this module.
    
    Returns:
    
    the name as specified in the module configuration
  - getVersion
```
public String getVersion()
```
    Returns the version of this module.
    
    Returns:
    
    the version as specified in the module configuration
  - getAuthor
```
public String getAuthor()
```
    Returns the author of this module.
    
    Returns:
    
    the author as specified in the module configuration
  - createUtils
```
public Module<E> createUtils(Document document)
```
    Creates a new utility file holding the information in the given document.
    
    Parameters:
    
    document - the document that holds the utility information
    
    Returns:
    
    the module
  - getUtils
```
public Document getUtils()
```
    Loads and returns the document containing utility information.
    
    Returns:
    
    the document containing utility information
  - saveUtils
```
public Module<E> saveUtils(Document document)
```
    Save the utility information.
    
    Parameters:
    
    document - the document containing the utility information
    
    Returns:
    
    the module
  - saveConfig
```
public Module<E> saveConfig()
```
    Save the configuration of this module.
    
    Returns:
    
    the module
  - getConfig
```
public Configuration getConfig()
```
    Returns the currently loaded configuration; loads it, if it isn't loaded already.
    
    Returns:
    
    the currently active configuration
  - loadConfiguration
```
private void loadConfiguration()
```
  - getDataFolder
```
public File getDataFolder()
```
    Returns the directory where the data of this module is stored. Creates the directory, if needed.
    
    Returns:
    
    the directory for storing module data
  - setDataFolder
```
public void setDataFolder(File dataFolder)
```
  - loadConfig
```
public Module<E> loadConfig()
```
    Load this module's configuration
    
    Returns:
    
    the module
  - getConfiguration
```
public Configuration getConfiguration()
```
  - setConfiguration
```
public void setConfiguration(Configuration configuration)
```
  - getConfigFile
```
public File getConfigFile()
```
  - setConfigFile
```
public void setConfigFile(File configFile)
```
  - getUtilFile
```
public File getUtilFile()
```
  - setUtilFile
```
public void setUtilFile(File utilFile)
```
  - getClassLoader
```
public ModuleClassLoader getClassLoader()
```
  - setClassLoader
```
public void setClassLoader(ModuleClassLoader classLoader)
```
  - getModuleConfig
```
public ModuleConfig getModuleConfig()
```
  - setModuleConfig
```
public void setModuleConfig(ModuleConfig moduleConfig)
```
  - getModuleLoader
```
public ModuleLoader getModuleLoader()
```
  - setModuleLoader
```
public void setModuleLoader(ModuleLoader moduleLoader)
```
  - getCloud
```
public abstract E getCloud()
```
    Returns the domain of this module.
    
    Returns:
    
    the cloud domain of this module

Class Module<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dataFolder

configFile

utilFile

moduleConfig

classLoader

configuration

moduleLoader

Constructor Detail

Module

Method Detail

hashCode

equals

toString

onLoad

onBootstrap

onShutdown

getName

getPluginName

getVersion

getAuthor

createUtils

getUtils

saveUtils

saveConfig

getConfig

loadConfiguration

getDataFolder

setDataFolder

loadConfig

getConfiguration

setConfiguration

getConfigFile

setConfigFile

getUtilFile

setUtilFile

getClassLoader

setClassLoader

getModuleConfig

setModuleConfig

getModuleLoader

setModuleLoader

getCloud