Index

A B C D E F G I K L N O P R S T U V
All Classes and Interfaces|All Packages|Serialized Form

A

addMapSource(Map<String, ?>) - Method in interface io.github.jonloucks.variants.api.Environment.Config.Builder

Add a new source based on a java.util.Map.

addPropertiesSource(Properties) - Method in interface io.github.jonloucks.variants.api.Environment.Config.Builder

Add a new source based on a java.util.Properties.

addSingletonSource(String, CharSequence) - Method in interface io.github.jonloucks.variants.api.Environment.Config.Builder

Create a VariantSource with a single key value pair

addSource(VariantSource) - Method in interface io.github.jonloucks.variants.api.Environment.Config.Builder

Add a new source

addSystemEnvironmentSource() - Method in interface io.github.jonloucks.variants.api.Environment.Config.Builder

Add System.getenv as a source.

addSystemPropertiesSource() - Method in interface io.github.jonloucks.variants.api.Environment.Config.Builder

Add System.getProperty as a source.

B

booleanParser() - Method in interface io.github.jonloucks.variants.api.Parsers

C

Checks - Class in io.github.jonloucks.variants.api

Responsibility: Common argument checking and validation

CONTRACT - Static variable in interface io.github.jonloucks.variants.api.EnvironmentFactory

The Contract for the EnvironmentFactory

CONTRACT - Static variable in interface io.github.jonloucks.variants.api.Parsers

Contract for Parsers

CONTRACT - Static variable in interface io.github.jonloucks.variants.api.VariantFactory

The Contract for the VariantFactory

CONTRACT - Static variable in interface io.github.jonloucks.variants.api.Variants

Access the current Variants implementation

CONTRACT - Static variable in interface io.github.jonloucks.variants.api.VariantsFactory

Used to promise and claim the VariantsFactory implementation

contracts() - Method in interface io.github.jonloucks.variants.api.Variants.Config

contracts(Contracts) - Method in interface io.github.jonloucks.variants.api.Variants.Config.Builder

create(Variants.Config) - Method in interface io.github.jonloucks.variants.api.VariantsFactory

Create a new instance of Variants

create(Consumer<Variants.Config.Builder>) - Method in interface io.github.jonloucks.variants.api.VariantsFactory

Create a new instance of Variants

createEnvironment(Environment.Config) - Method in interface io.github.jonloucks.variants.api.EnvironmentFactory

Create an Environment by configuration

createEnvironment(Environment.Config) - Static method in class io.github.jonloucks.variants.api.GlobalVariants

Create an Environment by configuration

createEnvironment(Consumer<Environment.Config.Builder>) - Method in interface io.github.jonloucks.variants.api.EnvironmentFactory

Create an Environment by configuration builder callback

createEnvironment(Consumer<Environment.Config.Builder>) - Static method in class io.github.jonloucks.variants.api.GlobalVariants

Create an Environment by configuration builder callback

createVariant(Variant.Config<T>) - Static method in class io.github.jonloucks.variants.api.GlobalVariants

createVariant(Variant.Config<T>) - Method in interface io.github.jonloucks.variants.api.VariantFactory

createVariant(BiConsumer<Variant.Config.Builder<T>, Parsers>) - Static method in class io.github.jonloucks.variants.api.GlobalVariants

Create a Variant by configuration builder callback

createVariant(BiConsumer<Variant.Config.Builder<T>, Parsers>) - Method in interface io.github.jonloucks.variants.api.VariantFactory

Create a Variant by configuration builder callback

createVariant(Consumer<Variant.Config.Builder<T>>) - Static method in class io.github.jonloucks.variants.api.GlobalVariants

Create a Variant by configuration builder callback

createVariant(Consumer<Variant.Config.Builder<T>>) - Method in interface io.github.jonloucks.variants.api.VariantFactory

Create a Variant by configuration builder callback

createVariants(Variants.Config) - Static method in class io.github.jonloucks.variants.api.GlobalVariants

Create a new Variants instance for customized deployments.

D

DEFAULT - Static variable in interface io.github.jonloucks.variants.api.Variants.Config

The default configuration used when creating a new Variants instance

description(String) - Method in interface io.github.jonloucks.variants.api.Variant.Config.Builder

Assign the description

doubleParser() - Method in interface io.github.jonloucks.variants.api.Parsers

durationParser() - Method in interface io.github.jonloucks.variants.api.Parsers

E

enumParser(Class<T>) - Method in interface io.github.jonloucks.variants.api.Parsers

A parser that converts a valid text value into a Boolean instance

Environment - Interface in io.github.jonloucks.variants.api

Responsibility: Locating variances from multiple sources.

Environment.Config - Interface in io.github.jonloucks.variants.api

Responsibility: Configuration for creating a new Environment

Environment.Config.Builder - Interface in io.github.jonloucks.variants.api

Responsibility: Builder a configuration used to create a new Environment

EnvironmentFactory - Interface in io.github.jonloucks.variants.api

Responsibility: The creation of an Environment

F

FACTORY - Static variable in interface io.github.jonloucks.variants.api.Variants.Config.Builder

Variants Variant Builder

fallback(Supplier<T>) - Method in interface io.github.jonloucks.variants.api.Variant.Config.Builder

Assign the fallback value supplier

find() - Method in class io.github.jonloucks.variants.api.VariantsFactoryFinder

Find a Variants factory

findVariance(Variant<T>) - Method in interface io.github.jonloucks.variants.api.Environment

Find a variance if it exists.

findVariantsFactory(Variants.Config) - Static method in class io.github.jonloucks.variants.api.GlobalVariants

Finds the VariantsFactory implementation

floatParser() - Method in interface io.github.jonloucks.variants.api.Parsers

G

getDescription() - Method in interface io.github.jonloucks.variants.api.Variant.Config

getDescription() - Method in interface io.github.jonloucks.variants.api.Variant

getFallback() - Method in interface io.github.jonloucks.variants.api.Variant.Config

getFallback() - Method in interface io.github.jonloucks.variants.api.Variant

getInstance() - Static method in class io.github.jonloucks.variants.api.GlobalVariants

Return the global instance of Contracts

getKeys() - Method in interface io.github.jonloucks.variants.api.Variant.Config

The primary use case of getting a property value by key

getKeys() - Method in interface io.github.jonloucks.variants.api.Variant

The primary use case of getting a property value by key

getLink() - Method in interface io.github.jonloucks.variants.api.Variant.Config

Links can be helpful when a Variant which does not have an explicit value can default the value of another Variant.

getLink() - Method in interface io.github.jonloucks.variants.api.Variant

Links can be helpful when a Variant which does not have an explicit value can default the value of another Variant.

getName() - Method in interface io.github.jonloucks.variants.api.Variant.Config

Note: The name is not used to look up values!

getName() - Method in interface io.github.jonloucks.variants.api.Variant

Note: The name is not used to look up values! Note: if name is not set the first key might be used

getOf() - Method in interface io.github.jonloucks.variants.api.Variant.Config

getParser() - Method in interface io.github.jonloucks.variants.api.Variant.Config

getSources() - Method in interface io.github.jonloucks.variants.api.Environment.Config

getSourceText(String) - Method in interface io.github.jonloucks.variants.api.VariantSource

Get optional source text for parsing variance value

getVariance(Variant<T>) - Method in interface io.github.jonloucks.variants.api.Environment

Get required variance or throw an exception.

GlobalVariants - Class in io.github.jonloucks.variants.api

Responsibility: Globally shared Variants

I

install(Variants.Config, Repository) - Method in interface io.github.jonloucks.variants.api.VariantsFactory

Install all the requirements and promises to the given Contracts Environment.

integerParser() - Method in interface io.github.jonloucks.variants.api.Parsers

io.github.jonloucks.variants.api - module io.github.jonloucks.variants.api

The API module for Variants

io.github.jonloucks.variants.api - package io.github.jonloucks.variants.api

K

key(String) - Method in interface io.github.jonloucks.variants.api.Variant.Config.Builder

Add a new key

keyCheck(String) - Static method in class io.github.jonloucks.variants.api.Checks

Check if given key is not null or invalid

keys(String...) - Method in interface io.github.jonloucks.variants.api.Variant.Config.Builder

Add a variable number of keys

keys(Collection<String>) - Method in interface io.github.jonloucks.variants.api.Variant.Config.Builder

Add a collection of keys

keysCheck(T) - Static method in class io.github.jonloucks.variants.api.Checks

Check if given is not null or invalid

L

link(Variant<T>) - Method in interface io.github.jonloucks.variants.api.Variant.Config.Builder

Assign a link

longParser() - Method in interface io.github.jonloucks.variants.api.Parsers

N

name(String) - Method in interface io.github.jonloucks.variants.api.Variant.Config.Builder

Assign the name

O

of(CharSequence) - Method in interface io.github.jonloucks.variants.api.Variant

Parses the text into an Optional Variant value Note: Required if keys are used to retrieve a value.

of(Function<CharSequence, Optional<T>>) - Method in interface io.github.jonloucks.variants.api.Variant.Config.Builder

Assign the main conversion method 'of' Note: Implementations should be aware that the default of implementation invokes the parser.

ofBoolean() - Method in interface io.github.jonloucks.variants.api.Parsers

Input is trimmed and empty values are skipped

ofDouble() - Method in interface io.github.jonloucks.variants.api.Parsers

Input is trimmed and empty values are skipped

ofDuration() - Method in interface io.github.jonloucks.variants.api.Parsers

Input is trimmed and empty values are skipped

ofEnum(Class<T>) - Method in interface io.github.jonloucks.variants.api.Parsers

text conversion to a Enm instance

ofFloat() - Method in interface io.github.jonloucks.variants.api.Parsers

Input is trimmed and empty values are skipped

ofInteger() - Method in interface io.github.jonloucks.variants.api.Parsers

Input is trimmed and empty values are skipped

ofList(Function<CharSequence, Optional<T>>, String) - Method in interface io.github.jonloucks.variants.api.Parsers

Split the input text and parse each part into a list

ofLong() - Method in interface io.github.jonloucks.variants.api.Parsers

Input is trimmed and empty values are skipped

ofRawString() - Method in interface io.github.jonloucks.variants.api.Parsers

No trimming or skipping empty values

ofString() - Method in interface io.github.jonloucks.variants.api.Parsers

Input is trimmed and empty values are skipped

ofTrimAndSkipEmpty(Function<CharSequence, T>) - Method in interface io.github.jonloucks.variants.api.Parsers

Text to parser helper.

P

parser(Function<CharSequence, T>) - Method in interface io.github.jonloucks.variants.api.Variant.Config.Builder

Assign the parser to convert text into Variant values A parser can return null for any reason, it is processed as unassigned

parserCheck(Function<F, T>) - Static method in class io.github.jonloucks.variants.api.Checks

Check if given parser is not null or invalid

Parsers - Interface in io.github.jonloucks.variants.api

Responsibility: Parsers to assist source text conversion for a Variant

R

reflectionClassName() - Method in interface io.github.jonloucks.variants.api.Variants.Config

reflectionClassName(String) - Method in interface io.github.jonloucks.variants.api.Variants.Config.Builder

rethrow(Throwable) - Static method in exception io.github.jonloucks.variants.api.VariantException

Rethrows a caught exception or a VariantException if unchecked

S

serviceLoaderClass() - Method in interface io.github.jonloucks.variants.api.Variants.Config

serviceLoaderClass(Class<? extends VariantsFactory>) - Method in interface io.github.jonloucks.variants.api.Variants.Config.Builder

string(Function<String, T>) - Method in interface io.github.jonloucks.variants.api.Parsers

A parser that converts text to a String

stringParser() - Method in interface io.github.jonloucks.variants.api.Parsers

T

textCheck(CharSequence) - Static method in class io.github.jonloucks.variants.api.Checks

Check if given text is null or invalid

trim(CharSequence) - Method in interface io.github.jonloucks.variants.api.Parsers

trim leading and trailing white space

U

useReflection() - Method in interface io.github.jonloucks.variants.api.Variants.Config

useReflection(boolean) - Method in interface io.github.jonloucks.variants.api.Variants.Config.Builder

useServiceLoader() - Method in interface io.github.jonloucks.variants.api.Variants.Config

useServiceLoader(boolean) - Method in interface io.github.jonloucks.variants.api.Variants.Config.Builder

V

validateVariants(Contracts, Variants) - Static method in class io.github.jonloucks.variants.api.Checks

Quickly validates a Contracts and Variants

Variant<T> - Interface in io.github.jonloucks.variants.api

Responsibility: Provide information on how to retrieve a configuration value.

Variant.Config<T> - Interface in io.github.jonloucks.variants.api

Responsibility: Configuration for creating a new Variant.

Variant.Config.Builder<T> - Interface in io.github.jonloucks.variants.api

Responsibility: Builder a configuration used to create a new Variant

variantCheck(Variant<T>) - Static method in class io.github.jonloucks.variants.api.Checks

Check if given Variant is not null or invalid

VariantException - Exception in io.github.jonloucks.variants.api

Responsibility: Runtime exception thrown for Variants related problems.

VariantException(String) - Constructor for exception io.github.jonloucks.variants.api.VariantException

Passthrough for RuntimeException(String)

VariantException(String, Throwable) - Constructor for exception io.github.jonloucks.variants.api.VariantException

Passthrough for RuntimeException(String, Throwable)

VariantFactory - Interface in io.github.jonloucks.variants.api

Responsibility: The creation of a Variant

Variants - Interface in io.github.jonloucks.variants.api

Responsibility: Provide access to essential Variant methods.

Variants.Config - Interface in io.github.jonloucks.variants.api

Responsibility: Configuration used to create a new Variants instance.

Variants.Config.Builder - Interface in io.github.jonloucks.variants.api

Responsibility: Build configuration to create a new Variants instance

variantsCheck(Variants) - Static method in class io.github.jonloucks.variants.api.Checks

Check if given Variants is not null or invalid

VariantsFactory - Interface in io.github.jonloucks.variants.api

Responsibility: Creating new instances of Variants

VariantsFactoryFinder - Class in io.github.jonloucks.variants.api

Responsibility: Locating and creating the VariantsFactory for a deployment.

VariantsFactoryFinder(Variants.Config) - Constructor for class io.github.jonloucks.variants.api.VariantsFactoryFinder

Create a new Variants Factory Finder

VariantSource - Interface in io.github.jonloucks.variants.api

Responsibility: Retrieve variance in text format

A B C D E F G I K L N O P R S T U V
All Classes and Interfaces|All Packages|Serialized Form