org.anvilpowered.anvil.base.plugin

Class BasePlugin<TPluginContainer>

java.lang.Object

org.anvilpowered.anvil.base.plugin.BasePlugin<TPluginContainer>

All Implemented Interfaces:

java.lang.Comparable<Plugin<TPluginContainer>>, Named, Plugin<TPluginContainer>

public abstract class BasePlugin<TPluginContainer>
extends java.lang.Object
implements Plugin<TPluginContainer>

A simple default implementation of Plugin that only registers a single Environment with the same name as this Plugin

Field Summary

Fields

Modifier and Type	Field and Description
protected Environment	environment
protected java.lang.String	name
protected TPluginContainer	pluginContainer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasePlugin(java.lang.String name)
protected	BasePlugin(java.lang.String name, com.google.inject.Injector rootInjector, com.google.inject.Module module)
protected	BasePlugin(java.lang.String name, com.google.inject.Injector rootInjector, com.google.inject.Module module, java.lang.Class<?>... earlyServices)
protected	BasePlugin(java.lang.String name, com.google.inject.Injector rootInjector, com.google.inject.Module module, com.google.inject.Key<?>... earlyServices)
protected	BasePlugin(java.lang.String name, com.google.inject.Injector rootInjector, com.google.inject.Module module, com.google.inject.TypeLiteral<?>... earlyServices)
protected	BasePlugin(java.lang.String name, com.google.inject.Injector rootInjector, com.google.inject.Module module, com.google.common.reflect.TypeToken<?>... earlyServices)

Method Summary

Modifier and Type	Method and Description
protected void	applyToBuilder(Environment.Builder builder)
int	compareTo(Plugin<TPluginContainer> o)
protected Environment.Builder	createDefaultBuilder(java.lang.String name, com.google.inject.Injector rootInjector, com.google.inject.Module module)
boolean	equals(java.lang.Object obj)
java.util.Set<Environment>	getAllEnvironments()
java.lang.String	getName()
TPluginContainer	getPluginContainer()
Environment	getPrimaryEnvironment() Note: while not explicitly necessary, it is generally advisable to override this method by getting the Environment from Environment.Builder#whenReady(Consumer) and setting it in a field in your implementing class
java.lang.String	toString()
protected void	whenLoaded(Environment environment)
protected void	whenReady(Environment environment)
protected void	whenReloaded(Environment environment)

Methods inherited from class java.lang.Object

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

Field Detail

pluginContainer

@Inject
protected TPluginContainer pluginContainer

environment

protected Environment environment

name

protected final java.lang.String name

Constructor Detail

BasePlugin

protected BasePlugin(java.lang.String name,
                     com.google.inject.Injector rootInjector,
                     com.google.inject.Module module,
                     com.google.inject.Key<?>... earlyServices)

BasePlugin

protected BasePlugin(java.lang.String name,
                     com.google.inject.Injector rootInjector,
                     com.google.inject.Module module,
                     java.lang.Class<?>... earlyServices)

BasePlugin

protected BasePlugin(java.lang.String name,
                     com.google.inject.Injector rootInjector,
                     com.google.inject.Module module,
                     com.google.inject.TypeLiteral<?>... earlyServices)

BasePlugin

protected BasePlugin(java.lang.String name,
                     com.google.inject.Injector rootInjector,
                     com.google.inject.Module module,
                     com.google.common.reflect.TypeToken<?>... earlyServices)

BasePlugin

protected BasePlugin(java.lang.String name,
                     com.google.inject.Injector rootInjector,
                     com.google.inject.Module module)

BasePlugin

protected BasePlugin(java.lang.String name)

Method Detail

createDefaultBuilder

protected Environment.Builder createDefaultBuilder(java.lang.String name,
                                                   com.google.inject.Injector rootInjector,
                                                   com.google.inject.Module module)

applyToBuilder

protected void applyToBuilder(Environment.Builder builder)

whenLoaded

protected void whenLoaded(Environment environment)

whenReady

protected void whenReady(Environment environment)

whenReloaded

protected void whenReloaded(Environment environment)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

Specified by:

getName in interface Named

compareTo

public int compareTo(Plugin<TPluginContainer> o)

Specified by:

compareTo in interface java.lang.Comparable<Plugin<TPluginContainer>>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getPluginContainer

public TPluginContainer getPluginContainer()

Specified by:

getPluginContainer in interface Plugin<TPluginContainer>

getPrimaryEnvironment

public Environment getPrimaryEnvironment()

Description copied from interface: Plugin

Note: while not explicitly necessary, it is generally advisable to override this method by getting the Environment from Environment.Builder#whenReady(Consumer) and setting it in a field in your implementing class

Specified by:

getPrimaryEnvironment in interface Plugin<TPluginContainer>

Returns:

The primary Environment for this Plugin

getAllEnvironments

public java.util.Set<Environment> getAllEnvironments()

Specified by:

getAllEnvironments in interface Plugin<TPluginContainer>

Returns:

A Set of all environments registered to this Plugin