Package journeymap.api.v2.client.util

Enum Class PluginHelper

java.lang.Object

java.lang.Enum<PluginHelper>

journeymap.api.v2.client.util.PluginHelper

All Implemented Interfaces:

Serializable, Comparable<PluginHelper>, Constable

@ParametersAreNonnullByDefault
public enum PluginHelper
extends Enum<PluginHelper>

Enum singleton used by JourneyMap to load and initialize plugins. A plugin class must be annotated with the JourneyMapPlugin annotation and also implement the IClientPlugin interface.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	initialized
static final org.apache.logging.log4j.Logger	LOGGER
static final String	PLUGIN_INTERFACE_NAME
protected Map<String,IClientPlugin>	plugins

Method Summary

Modifier and Type	Method	Description
Map<String,IClientPlugin>	getPlugins()	Get the map of plugins, keyed by modId.
Map<String,IClientPlugin>	initPlugins(IClientAPI clientAPI)	Called by JourneyMap during its initialization phase.
Map<String,IClientPlugin>	preInitPlugins(List<String> pluginList)	Called by JourneyMap during it's preInitialization phase to find plugin classes included in other mods and then instantiate them.
static PluginHelper	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PluginHelper[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final PluginHelper INSTANCE

Field Details

LOGGER

public static final org.apache.logging.log4j.Logger LOGGER

PLUGIN_INTERFACE_NAME

public static final String PLUGIN_INTERFACE_NAME

plugins

protected Map<String,IClientPlugin> plugins

initialized

protected boolean initialized

Method Details

values

public static PluginHelper[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PluginHelper valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

preInitPlugins

public Map<String,IClientPlugin> preInitPlugins(List<String> pluginList)

Called by JourneyMap during it's preInitialization phase to find plugin classes included in other mods and then instantiate them.

Mods which are testing integration can also call this in a dev environment and pass in a stub implementation, but must never do so in production code.

Returns:

map of instantiated plugins, keyed by modId

initPlugins

public Map<String,IClientPlugin> initPlugins(IClientAPI clientAPI)

Called by JourneyMap during its initialization phase. Can only be called once per runtime.

Mods which are testing integration can also call this in a dev environment and pass in a stub implementation, but must never do so in production code.

Parameters:

clientAPI - Client API implementation

Returns:

list of initialized plugins, null if plugin discovery never occurred

getPlugins

public Map<String,IClientPlugin> getPlugins()

Get the map of plugins, keyed by modId.

Returns:

null if preInitPlugins(List) hasn't been called yet