Package com.demonwav.hypo.core

Class HypoContext.Builder

java.lang.Object

com.demonwav.hypo.core.HypoContext.Builder

Enclosing class:

HypoContext

public static final class HypoContext.Builder
extends Object

Builder class for creating new instances of HypoContext. Create new instances of this builder with HypoContext.builder().

This class is structured as the write-only version of HypoContext, which is read-only.

Constructor Summary

Constructors

Constructor	Description
Builder()	Constructor for HypoContext.Builder.

Method Summary

Modifier and Type	Method	Description
@NotNull HypoContext	build()	Use the current values of this builder to create a new instance of HypoContext and return it.
HypoContext.Builder	clearContextProviders()	Clear the current set of context providers.
HypoContext.Builder	clearProviders()	Clear the current set of core providers.
HypoContext.Builder	withConfig(@NotNull HypoConfig config)	Set the config for the context to be built.
HypoContext.Builder	withContextProvider(@NotNull ClassDataProvider provider)	Add the given provider as a context provider.
HypoContext.Builder	withContextProviders(@NotNull ClassDataProvider @NotNull ... providers)	Add multiple providers as context providers.
HypoContext.Builder	withContextProviders(@NotNull Collection<@NotNull ? extends ClassDataProvider> providers)	Add a collection of provider as context providers.
HypoContext.Builder	withProvider(@NotNull ClassDataProvider provider)	Add the given provider as a core provider to analyze.
HypoContext.Builder	withProviders(@NotNull ClassDataProvider @NotNull ... providers)	Add multiple providers as core providers to analyze.
HypoContext.Builder	withProviders(@NotNull Collection<@NotNull ? extends ClassDataProvider> providers)	Add a collection of provider as core providers to analyze.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

Builder()

Constructor for HypoContext.Builder. Use HypoContext.builder() instead.

Method Details

withProvider

@CanIgnoreReturnValue
@Contract(value="_ -> this",
          mutates="this")
@NotNull
public HypoContext.Builder withProvider(@NotNull
 @NotNull ClassDataProvider provider)

Add the given provider as a core provider to analyze.

Parameters:

provider - The provider to add to the set of core providers.

Returns:

this for chaining.

withProviders

@CanIgnoreReturnValue
@Contract(value="_ -> this",
          mutates="this")
@NotNull
public HypoContext.Builder withProviders(@NotNull
 @NotNull ClassDataProvider @NotNull ... providers)

Add multiple providers as core providers to analyze.

Parameters:

providers - The providers to add to the set of core providers.

Returns:

this for chaining.

withProviders

@CanIgnoreReturnValue
@Contract(value="_ -> this",
          mutates="this")
@NotNull
public HypoContext.Builder withProviders(@NotNull
 @NotNull Collection<@NotNull ? extends ClassDataProvider> providers)

Add a collection of provider as core providers to analyze.

Parameters:

providers - The providers to add to the set of core providers.

Returns:

this for chaining.

clearProviders

@CanIgnoreReturnValue
@Contract(value="-> this",
          mutates="this")
@NotNull
public HypoContext.Builder clearProviders()

Clear the current set of core providers.

Returns:

this for chaining.

withContextProvider

@CanIgnoreReturnValue
@Contract(value="_ -> this",
          mutates="this")
@NotNull
public HypoContext.Builder withContextProvider(@NotNull
 @NotNull ClassDataProvider provider)

Add the given provider as a context provider.

Parameters:

provider - The provider to add to the set of context providers.

Returns:

this for chaining.

withContextProviders

@CanIgnoreReturnValue
@Contract(value="_ -> this",
          mutates="this")
@NotNull
public HypoContext.Builder withContextProviders(@NotNull
 @NotNull ClassDataProvider @NotNull ... providers)

Add multiple providers as context providers.

Parameters:

providers - The providers to add to the set of context providers.

Returns:

this for chaining.

withContextProviders

@CanIgnoreReturnValue
@Contract(value="_ -> this",
          mutates="this")
@NotNull
public HypoContext.Builder withContextProviders(@NotNull
 @NotNull Collection<@NotNull ? extends ClassDataProvider> providers)

Add a collection of provider as context providers.

Parameters:

providers - The providers to add to the set of context providers.

Returns:

this for chaining.

clearContextProviders

@CanIgnoreReturnValue
@Contract(value="-> this",
          mutates="this")
@NotNull
public HypoContext.Builder clearContextProviders()

Clear the current set of context providers.

Returns:

this for chaining.

withConfig

@CanIgnoreReturnValue
@Contract(value="_ -> this",
          mutates="this")
@NotNull
public HypoContext.Builder withConfig(@NotNull
 @NotNull HypoConfig config)

Set the config for the context to be built.

This defaults to:

     HypoConfig.builder().build()
 

Parameters:

config - The config to set.

Returns:

this for chaining.

build

@Contract(value="-> new",
          pure=true)
@NotNull
public @NotNull HypoContext build()

Use the current values of this builder to create a new instance of HypoContext and return it.

Returns:

The new instance of HypoContext using the values set in this builder.