Class PlexModuleFile

java.lang.Object

dev.plex.module.PlexModuleFile

public final class PlexModuleFile
extends Object

Information read from a module's module.yml file. A module name can contain letters, digits, periods, underscores, and hyphens. Its maximum length is 64 characters.

Constructor Summary

Constructors

Constructor	Description
PlexModuleFile(String name, String main, String description, String version, int apiCompatibility)	Creates module information.
PlexModuleFile(String name, String main, String description, String version, int apiCompatibility, List<String> libraries, List<String> repositories, boolean updaterEnabled, List<String> updateUrls)	Creates module data.

Method Summary

Modifier and Type	Method	Description
int	getApiCompatibility()	Returns the required Plex API compatibility version.
String	getDescription()	Returns the module description.
List<String>	getLibraries()	Returns dependency libraries declared by the module.
String	getMain()	Returns the main module class.
String	getName()	Returns the module name.
List<String>	getRepositories()	Returns Maven repositories declared by the module.
List<String>	getUpdateUrls()	Returns custom updater base URLs declared by the module.
String	getVersion()	Returns the module version.
boolean	isUpdaterEnabled()	Returns whether Plex should include this module in module update commands.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlexModuleFile

public PlexModuleFile(String name,
 String main,
 String description,
 String version,
 int apiCompatibility)

Creates module information.

Parameters:

name - module name

main - main module class

description - module description

version - module version

apiCompatibility - required Plex API compatibility version

PlexModuleFile

public PlexModuleFile(String name,
 String main,
 String description,
 String version,
 int apiCompatibility,
 List<String> libraries,
 List<String> repositories,
 boolean updaterEnabled,
 List<String> updateUrls)

Creates module data.

Parameters:

name - module name

main - main module class

description - module description

version - module version

apiCompatibility - required Plex API version

libraries - dependency libraries

repositories - Maven repositories

updaterEnabled - whether module updates are enabled

updateUrls - custom update base URLs

Method Details

getName

public String getName()

Returns the module name.

Returns:

module name

getMain

public String getMain()

Returns the main module class.

Returns:

main module class

getDescription

public String getDescription()

Returns the module description.

Returns:

module description

getVersion

public String getVersion()

Returns the module version.

Returns:

module version

getApiCompatibility

public int getApiCompatibility()

Returns the required Plex API compatibility version.

Returns:

required Plex API compatibility version

getLibraries

public List<String> getLibraries()

Returns dependency libraries declared by the module.

Returns:

dependency libraries declared by the module

getRepositories

public List<String> getRepositories()

Returns Maven repositories declared by the module.

Returns:

Maven repositories declared by the module

isUpdaterEnabled

public boolean isUpdaterEnabled()

Returns whether Plex should include this module in module update commands.

Returns:

true when module updates are enabled

getUpdateUrls

public List<String> getUpdateUrls()

Returns custom updater base URLs declared by the module.

An empty list tells Plex to use its default update URLs.

Returns:

custom updater base URLs