Module io.github.jonloucks.variants.api

Package io.github.jonloucks.variants.api

Class GlobalVariants

java.lang.Object

io.github.jonloucks.variants.api.GlobalVariants

public final class GlobalVariants
extends Object

Responsibility: Globally shared Variants

Method Summary

Modifier and Type	Method	Description
static Environment	createEnvironment(Environment.Config config)	Create an Environment by configuration
static Environment	createEnvironment(Consumer<Environment.Config.Builder> builderConsumer)	Create an Environment by configuration builder callback
static <T> Variant<T>	createVariant(Variant.Config<T> config)
static <T> Variant<T>	createVariant(Consumer<Variant.Config.Builder<T>> builderConsumer)	Create a Variant by configuration builder callback
static Variants	createVariants(Variants.Config config)	Create a new Variants instance for customized deployments.
static Optional<VariantsFactory>	findVariantsFactory(Variants.Config config)	Finds the VariantsFactory implementation
static Variants	getInstance()	Return the global instance of Contracts

Methods inherited from class java.lang.Object

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

Method Details

createVariant

public static <T> Variant<T> createVariant(Consumer<Variant.Config.Builder<T>> builderConsumer)

Create a Variant by configuration builder callback

Type Parameters:

T - the Variant value type

Parameters:

builderConsumer - receives the configuration builder

Returns:

the new Variant

createVariant

public static <T> Variant<T> createVariant(Variant.Config<T> config)

Type Parameters:

T - the Variant value type

Parameters:

config - the configuration for creating the Variant

Returns:

the new Variant

createEnvironment

public static Environment createEnvironment(Environment.Config config)

Create an Environment by configuration

Parameters:

config - the configuration

Returns:

the new Environment

createEnvironment

public static Environment createEnvironment(Consumer<Environment.Config.Builder> builderConsumer)

Create an Environment by configuration builder callback

Parameters:

builderConsumer - receives the configuration builder

Returns:

the new Environment

getInstance

public static Variants getInstance()

Return the global instance of Contracts

Returns:

the instance

createVariants

public static Variants createVariants(Variants.Config config)

Create a new Variants instance for customized deployments. Note: GlobalVariants has everything feature, this api allows creation of more than once instance of Variants.

Parameters:

config - the Variants configuration

Returns:

the new Variants

Throws:

IllegalArgumentException - if config is null or invalid

See Also:

• Note: Services created from this method are destink any that used internally

  Caller is responsible for invoking open() before use and close when no longer needed

findVariantsFactory

public static Optional<VariantsFactory> findVariantsFactory(Variants.Config config)

Finds the VariantsFactory implementation

Parameters:

config - the configuration used to find the factory

Returns:

the factory if found

Throws:

IllegalArgumentException - if config is null or invalid