Package com.demonwav.hypo.core

Class HypoContext

java.lang.Object

com.demonwav.hypo.core.HypoContext

All Implemented Interfaces:

AutoCloseable

public final class HypoContext
extends Object
implements AutoCloseable

Core context for Hypo executions. A context contains 4 major components:

1. The core provider - The classes to analyze
2. The context provider - Additional classes on the classpath for completing the analysis of the core provider
3. The current configuration - Global configuration values
4. The current executor - The shared executor to use for all multi-threaded work

When a context is closed both providers are closed and the executor is shut down. The context should never be closed while processes in the executor are still running. To put that another way, any operations which use the executor should wait for all submitted jobs to complete before continuing.

Create new instances with builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HypoContext.Builder	Builder class for creating new instances of HypoContext.

Constructor Summary

Constructors

Constructor	Description
HypoContext(@NotNull HypoConfig config, @NotNull ClassDataProvider provider, @NotNull ClassDataProvider contextProvider)	Create a new instance of HypoContext.

Method Summary

Modifier and Type	Method	Description
static HypoContext.Builder	builder()	Create a new builder for creating new instances of HypoContext.
void	close()
@NotNull HypoConfig	getConfig()	Returns the config.
@NotNull ClassDataProvider	getContextProvider()	Returns the context provider.
@NotNull ExecutorService	getExecutor()	Returns the current executor, if there is one.
@NotNull ClassDataProvider	getProvider()	Returns the core provider.

Methods inherited from class java.lang.Object

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

Constructor Details

HypoContext

HypoContext(@NotNull
 @NotNull HypoConfig config,
 @NotNull
 @NotNull ClassDataProvider provider,
 @NotNull
 @NotNull ClassDataProvider contextProvider)

Create a new instance of HypoContext. Use builder() instead.

Parameters:

config - The config to use for this context.

provider - The provider to use as the core provider to analyze.

contextProvider - The provider to use as the context provider.

Method Details

getConfig

@NotNull
public @NotNull HypoConfig getConfig()

Returns the config.

Returns:

The config.

getProvider

@NotNull
public @NotNull ClassDataProvider getProvider()

Returns the core provider.

Returns:

The core provider.

getContextProvider

@NotNull
public @NotNull ClassDataProvider getContextProvider()

Returns the context provider.

Returns:

The context provider.

getExecutor

@NotNull
public @NotNull ExecutorService getExecutor()

Returns the current executor, if there is one. If there isn't one already created, a new executor will be created according to the configuration and returned. This executor will be used for all subsequent requests until this context is closed.

This method is thread safe: Multiple threads may call it concurrently and they will all receive the same executor. Concurrent accesses to this method while the executor is being created will all receive the same executor.

Returns:

The current executor.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

builder

@Contract("-> new")
@NotNull
public static HypoContext.Builder builder()

Create a new builder for creating new instances of HypoContext.

Returns:

A new HypoContext.Builder instance.