com.comphenix.protocol.reflect.compiler

Class BackgroundCompiler

java.lang.Object

com.comphenix.protocol.reflect.compiler.BackgroundCompiler

public class BackgroundCompiler
extends java.lang.Object

Compiles structure modifiers on a background thread.

This is necessary as we cannot block the main thread.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHUTDOWN_DELAY_MS

Constructor Summary

Constructors

Constructor and Description
BackgroundCompiler(java.lang.ClassLoader loader) Initialize a background compiler.
BackgroundCompiler(java.lang.ClassLoader loader, java.util.concurrent.ExecutorService executor) Initialize a background compiler utilizing the given thread pool.

Method Summary

Methods

Modifier and Type	Method and Description
StructureCompiler	getCompiler() Retrieve the current structure compiler.
static BackgroundCompiler	getInstance() Retrieves the current background compiler.
boolean	isEnabled() Retrieve whether or not the background compiler is enabled.
void	scheduleCompilation(java.util.Map<java.lang.Class,StructureModifier> cache, java.lang.Class key) Ensure that the indirectly given structure modifier is eventually compiled.
<TKey> void	scheduleCompilation(StructureModifier<TKey> uncompiled, CompileListener<TKey> listener) Ensure that the given structure modifier is eventually compiled.
void	setEnabled(boolean enabled) Sets whether or not the background compiler is enabled.
static void	setInstance(BackgroundCompiler backgroundCompiler) Sets the single background compiler we're using.
void	shutdownAll() Clean up after ourselves using the default timeout.
void	shutdownAll(long timeout, java.util.concurrent.TimeUnit unit) Clean up after ourselves.

Methods inherited from class java.lang.Object

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

Field Detail

SHUTDOWN_DELAY_MS

public static final int SHUTDOWN_DELAY_MS

See Also:

Constant Field Values

Constructor Detail

BackgroundCompiler

public BackgroundCompiler(java.lang.ClassLoader loader)

Initialize a background compiler.

Parameters:

loader - - class loader from Bukkit.

BackgroundCompiler

public BackgroundCompiler(java.lang.ClassLoader loader,
                  java.util.concurrent.ExecutorService executor)

Initialize a background compiler utilizing the given thread pool.

Parameters:

loader - - class loader from Bukkit.

executor - - thread pool we'll use.

Method Detail

getInstance

public static BackgroundCompiler getInstance()

Retrieves the current background compiler.

Returns:

Current background compiler.

setInstance

public static void setInstance(BackgroundCompiler backgroundCompiler)

Sets the single background compiler we're using.

Parameters:

backgroundCompiler - - current background compiler, or NULL if the library is not loaded.

scheduleCompilation

public void scheduleCompilation(java.util.Map<java.lang.Class,StructureModifier> cache,
                       java.lang.Class key)

Ensure that the indirectly given structure modifier is eventually compiled.

Parameters:

cache - - store of structure modifiers.

key - - key of the structure modifier to compile.

scheduleCompilation

public <TKey> void scheduleCompilation(StructureModifier<TKey> uncompiled,
                              CompileListener<TKey> listener)

Ensure that the given structure modifier is eventually compiled.

Parameters:

uncompiled - - structure modifier to compile.

listener - - listener responsible for responding to the compilation.

shutdownAll

public void shutdownAll()

Clean up after ourselves using the default timeout.

shutdownAll

public void shutdownAll(long timeout,
               java.util.concurrent.TimeUnit unit)

Clean up after ourselves.

Parameters:

timeout - - the maximum time to wait.

unit - - the time unit of the timeout argument.

isEnabled

public boolean isEnabled()

Retrieve whether or not the background compiler is enabled.

Returns:

TRUE if it is enabled, FALSE otherwise.

setEnabled

public void setEnabled(boolean enabled)

Sets whether or not the background compiler is enabled.

Parameters:

enabled - - TRUE to enable it, FALSE otherwise.

getCompiler

public StructureCompiler getCompiler()

Retrieve the current structure compiler.

Returns:

Current structure compiler.