Package com.ultikits.ultitools.utils

Class PluginYmlReader.PluginYmlInfo

java.lang.Object

com.ultikits.ultitools.utils.PluginYmlReader.PluginYmlInfo

Enclosing class:

PluginYmlReader

public static final class PluginYmlReader.PluginYmlInfo
extends Object

The subset of a module's plugin.yml this framework needs: its declared name: and main: (both nullable - absent when the archive has none or reading failed), its loadAfter: list, and its Bukkit-level softdepend: / depend: lists (all three never null; empty when absent or reading failed), and its declared version: and api-version: as text (both nullable, like name and main), which the load-failure refusal quotes to identify the module.

softDepend was added for UltiEconomy#20's optional-dependency log-level decision: a class that fails to load only because it references a type belonging to a plugin the module's own plugin.yml lists under softdepend:, and that plugin is not currently installed/enabled, is not a defect in the module -- Bukkit's own softdepend: contract is precisely "this plugin may be absent; the module must tolerate that". depend is carried alongside it for the same reason -- a module cannot actually be running at all if a hard depend: were genuinely missing, but the list is threaded through regardless so a diagnostic message can name it if that ever changes.

Since:

6.3.0

Field Summary

Fields

Modifier and Type	Field	Description
private final String	apiVersion
private final List<String>	depend
static final PluginYmlReader.PluginYmlInfo	EMPTY	The empty result every failure path returns.
private final List<String>	loadAfter
private final String	main
private final String	name
private final List<String>	softDepend
private final String	version

Constructor Summary

Constructors

Constructor	Description
PluginYmlInfo(String name, String main, List<String> loadAfter, List<String> softDepend, List<String> depend)
PluginYmlInfo(String name, String main, List<String> loadAfter, List<String> softDepend, List<String> depend, String version, String apiVersion)

Method Summary

Modifier and Type	Method	Description
String	getApiVersion()	The module's declared plugin.yml api-version: value -- the UltiTools API level the module was written for -- as text.
List<String>	getDepend()	The module's declared plugin.yml depend: list -- plugin names this module requires to be present.
List<String>	getLoadAfter()	The module's declared plugin.yml loadAfter: list.
String	getMain()	The module's declared plugin.yml main: value.
String	getName()	The module's declared plugin.yml name: value.
List<String>	getSoftDepend()	The module's declared plugin.yml softdepend: list -- plugin names this module integrates with optionally.
String	getVersion()	The module's declared plugin.yml version: value, as text.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final PluginYmlReader.PluginYmlInfo EMPTY

The empty result every failure path returns.

name

private final String name

main

private final String main

loadAfter

private final List<String> loadAfter

softDepend

private final List<String> softDepend

depend

private final List<String> depend

version

private final String version

apiVersion

private final String apiVersion

Constructor Details

PluginYmlInfo

PluginYmlInfo(String name,
 String main,
 List<String> loadAfter,
 List<String> softDepend,
 List<String> depend)

PluginYmlInfo

PluginYmlInfo(String name,
 String main,
 List<String> loadAfter,
 List<String> softDepend,
 List<String> depend,
 String version,
 String apiVersion)

Method Details

getName

public String getName()

The module's declared plugin.yml name: value.

Returns:

the declared name, or null if absent or unreadable

Since:

6.3.0

getMain

public String getMain()

The module's declared plugin.yml main: value.

Returns:

the declared main class name, or null if absent or unreadable

Since:

6.3.0

getLoadAfter

public List<String> getLoadAfter()

The module's declared plugin.yml loadAfter: list.

Returns:

the loadAfter list, never null; empty if absent or unreadable

Since:

6.3.0

getSoftDepend

public List<String> getSoftDepend()

The module's declared plugin.yml softdepend: list -- plugin names this module integrates with optionally.

Returns:

the softdepend list, never null; empty if absent or unreadable

Since:

6.3.0

getDepend

public List<String> getDepend()

The module's declared plugin.yml depend: list -- plugin names this module requires to be present.

Returns:

the depend list, never null; empty if absent or unreadable

Since:

6.3.0

getVersion

public String getVersion()

The module's declared plugin.yml version: value, as text.

Returns:

the declared version, or null if absent or unreadable

Since:

6.3.0

getApiVersion

public String getApiVersion()

The module's declared plugin.yml api-version: value -- the UltiTools API level the module was written for -- as text.

Returns:

the declared api-version, or null if absent or unreadable

Since:

6.3.0