org.anvilpowered.anvil.api

Interface Environment.Builder

Enclosing interface:

Environment

public static interface Environment.Builder

Method Summary

Modifier and Type	Method and Description
Environment.Builder	addEarlyServices(java.lang.Class<?>... classes)
<T> Environment.Builder	addEarlyServices(java.lang.Class<T> clazz, java.util.function.Consumer<T> initializer)
Environment.Builder	addEarlyServices(java.lang.Iterable<com.google.inject.Key<?>> keys)
Environment.Builder	addEarlyServices(com.google.inject.Key<?>... keys)
<T> Environment.Builder	addEarlyServices(com.google.inject.Key<T> key, java.util.function.Consumer<T> initializer)
Environment.Builder	addEarlyServices(com.google.inject.TypeLiteral<?>... typeLiterals)
<T> Environment.Builder	addEarlyServices(com.google.inject.TypeLiteral<T> typeLiteral, java.util.function.Consumer<T> initializer)
Environment.Builder	addEarlyServices(com.google.common.reflect.TypeToken<?>... typeTokens)
<T> Environment.Builder	addEarlyServices(com.google.common.reflect.TypeToken<T> typeToken, java.util.function.Consumer<T> initializer)
Environment.Builder	addModules(java.lang.Iterable<com.google.inject.Module> modules)
Environment.Builder	addModules(com.google.inject.Module... modules)
void	register(Plugin<?> plugin) Builds an Environment and registers it.
Environment.Builder	setName(java.lang.String name) Sets the name for this environment builder.
Environment.Builder	setRootInjector(@Nullable com.google.inject.Injector rootInjector) Sets the root injector for this environment builder.
Environment.Builder	whenLoaded(java.util.function.Consumer<Environment> listener) Called when the Environment is loaded.
Environment.Builder	whenReady(java.util.function.Consumer<Environment> listener) Called when the Environment is loaded for the first time.
Environment.Builder	whenReloaded(java.util.function.Consumer<Environment> listener) Called when the Environment is reloaded.
Environment.Builder	withRootCommand() This will load your root CommandNode as defined by your guice module

Method Detail

addModules

Environment.Builder addModules(com.google.inject.Module... modules)

addModules

Environment.Builder addModules(java.lang.Iterable<com.google.inject.Module> modules)

addEarlyServices

Environment.Builder addEarlyServices(com.google.inject.Key<?>... keys)

addEarlyServices

Environment.Builder addEarlyServices(java.lang.Iterable<com.google.inject.Key<?>> keys)

addEarlyServices

Environment.Builder addEarlyServices(java.lang.Class<?>... classes)

addEarlyServices

Environment.Builder addEarlyServices(com.google.inject.TypeLiteral<?>... typeLiterals)

addEarlyServices

Environment.Builder addEarlyServices(com.google.common.reflect.TypeToken<?>... typeTokens)

addEarlyServices

<T> Environment.Builder addEarlyServices(com.google.inject.Key<T> key,
                                         java.util.function.Consumer<T> initializer)

addEarlyServices

<T> Environment.Builder addEarlyServices(java.lang.Class<T> clazz,
                                         java.util.function.Consumer<T> initializer)

addEarlyServices

<T> Environment.Builder addEarlyServices(com.google.inject.TypeLiteral<T> typeLiteral,
                                         java.util.function.Consumer<T> initializer)

addEarlyServices

<T> Environment.Builder addEarlyServices(com.google.common.reflect.TypeToken<T> typeToken,
                                         java.util.function.Consumer<T> initializer)

setName

Environment.Builder setName(java.lang.String name)

Sets the name for this environment builder.

Parameters:

name - String Name to set.

Returns:

this

setRootInjector

Environment.Builder setRootInjector(@Nullable
                                    @Nullable com.google.inject.Injector rootInjector)

Sets the root injector for this environment builder.

Parameters:

rootInjector - Injector to set. Pass null to unset.

Returns:

this

withRootCommand

Environment.Builder withRootCommand()

This will load your root CommandNode as defined by your guice module

Returns:

this

whenLoaded

Environment.Builder whenLoaded(java.util.function.Consumer<Environment> listener)

Called when the Environment is loaded.

This Consumer will be invoked when the Environment is first loaded and on subsequent reloads.

This method can be called multiple times on one builder. Preexisting listeners will be used and will not be overridden.

Parameters:

listener - Consumer to run when this environment is loaded

Returns:

this

whenReady

Environment.Builder whenReady(java.util.function.Consumer<Environment> listener)

Called when the Environment is loaded for the first time.

This Consumer will only be invoked when the Environment is loaded for the first time.

This method can be called multiple times on one builder. Preexisting listeners will be used and will not be overridden.

Parameters:

listener - Consumer to run when this environment is ready

Returns:

this

whenReloaded

Environment.Builder whenReloaded(java.util.function.Consumer<Environment> listener)

Called when the Environment is reloaded.

This Consumer will only be invoked when the Environment is reloaded, but not when it is first loaded.

This method can be called multiple times on one builder. Preexisting listeners will be used and will not be overridden.

Parameters:

listener - Consumer to run when this environment is reloaded

Returns:

this

register

void register(Plugin<?> plugin)

Builds an Environment and registers it.

Parameters:

plugin - Plugin owner for this environment