Skip navigation links

MicroProfile Config API v3.0.1
A B C D F G I N O P R S U W 

A

addDefaultSources() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Add the default configuration sources to the configuration being built.
addDiscoveredConverters() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Add all configuration converters which can be discovered from this configuration builder's class loader.
addDiscoveredSources() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Add all configuration sources which can be discovered from this configuration builder's class loader.

B

build() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Build a new Config instance based on this builder instance.

C

Config - Interface in org.eclipse.microprofile.config
Resolves the property value by searching through all configured ConfigSources.
CONFIG_ORDINAL - Static variable in interface org.eclipse.microprofile.config.spi.ConfigSource
The name of the configuration ordinal property, "config_ordinal".
ConfigBuilder - Interface in org.eclipse.microprofile.config.spi
A builder for manually creating a configuration instance.
ConfigProperties - Annotation Type in org.eclipse.microprofile.config.inject
Retrieve a number of related configuration properties with the specified prefix into a property class.
ConfigProperties.Literal - Class in org.eclipse.microprofile.config.inject
Support inline instantiation of the ConfigProperties qualifier.
ConfigProperty - Annotation Type in org.eclipse.microprofile.config.inject
Binds the injection point with a configured value.
ConfigProvider - Class in org.eclipse.microprofile.config
This is the central class to access a Config.
ConfigProviderResolver - Class in org.eclipse.microprofile.config.spi
The service provider for implementations of the MicroProfile Configuration specification.
ConfigProviderResolver() - Constructor for class org.eclipse.microprofile.config.spi.ConfigProviderResolver
Construct a new instance.
ConfigSource - Interface in org.eclipse.microprofile.config.spi
A configuration source which provides configuration values from a specific place.
ConfigSourceProvider - Interface in org.eclipse.microprofile.config.spi
A provider for configuration source instances.
ConfigValue - Interface in org.eclipse.microprofile.config
The ConfigValue holds additional information after the lookup of a configuration property and is itself immutable.
convert(String) - Method in interface org.eclipse.microprofile.config.spi.Converter
Convert the given string value to a specified type.
Converter<T> - Interface in org.eclipse.microprofile.config.spi
A mechanism for converting configured values from String to any Java type.

D

DEFAULT_ORDINAL - Static variable in interface org.eclipse.microprofile.config.spi.ConfigSource
The default configuration ordinal value, 100.

F

forClassLoader(ClassLoader) - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Specify the class loader for which this configuration is being built.

G

getBuilder() - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
Create a ConfigBuilder instance for the current application.
getConfig() - Static method in class org.eclipse.microprofile.config.ConfigProvider
Get the configuration corresponding to the current application, as defined by the calling thread's context class loader.
getConfig(ClassLoader) - Static method in class org.eclipse.microprofile.config.ConfigProvider
Get the configuration for the application corresponding to the given class loader instance.
getConfig() - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
Get the configuration instance for the current application in the manner described by ConfigProvider.getConfig().
getConfig(ClassLoader) - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
Get the configuration instance for the current application in the manner described by ConfigProvider.getConfig(ClassLoader).
getConfigSources() - Method in interface org.eclipse.microprofile.config.Config
Return all of the currently registered configuration sources for this configuration.
getConfigSources(ClassLoader) - Method in interface org.eclipse.microprofile.config.spi.ConfigSourceProvider
Return the ConfigSource instances that are provided by this provider.
getConfigValue(String) - Method in interface org.eclipse.microprofile.config.Config
Return the ConfigValue for the specified property name from the underlying configuration source.
getConverter(Class<T>) - Method in interface org.eclipse.microprofile.config.Config
Return the Converter used by this instance to produce instances of the specified type from string values.
getName() - Method in interface org.eclipse.microprofile.config.ConfigValue
The name of the property.
getName() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
The name of the configuration source.
getOptionalValue(String, Class<T>) - Method in interface org.eclipse.microprofile.config.Config
Return the resolved property value with the specified type for the specified property name from the underlying configuration sources.
getOptionalValues(String, Class<T>) - Method in interface org.eclipse.microprofile.config.Config
Return the resolved property values with the specified type for the specified property name from the underlying configuration sources.
getOrdinal() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
Return the ordinal priority value of this configuration source.
getProperties() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
Return the properties in this configuration source as a map.
getPropertyNames() - Method in interface org.eclipse.microprofile.config.Config
Returns a sequence of configuration property names.
getPropertyNames() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
Gets all property names known to this configuration source, potentially without evaluating the values.
getRawValue() - Method in interface org.eclipse.microprofile.config.ConfigValue
The value of the property lookup without any transformation (expanded , etc).
getSourceName() - Method in interface org.eclipse.microprofile.config.ConfigValue
The ConfigSource name that loaded the property lookup.
getSourceOrdinal() - Method in interface org.eclipse.microprofile.config.ConfigValue
The ConfigSource ordinal that loaded the property lookup.
getValue(String, Class<T>) - Method in interface org.eclipse.microprofile.config.Config
Return the resolved property value with the specified type for the specified property name from the underlying configuration sources.
getValue() - Method in interface org.eclipse.microprofile.config.ConfigValue
The value of the property lookup with transformations (expanded, etc).
getValue(String) - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
Return the value for the specified property in this configuration source.
getValues(String, Class<T>) - Method in interface org.eclipse.microprofile.config.Config
Return the resolved property values with the specified type for the specified property name from the underlying configuration sources.

I

instance() - Static method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
Find and return the provider resolver instance.

N

NO_PREFIX - Static variable in class org.eclipse.microprofile.config.inject.ConfigProperties.Literal
 

O

of(String) - Static method in class org.eclipse.microprofile.config.inject.ConfigProperties.Literal
 
org.eclipse.microprofile.config - package org.eclipse.microprofile.config
Configuration for Java MicroProfile
org.eclipse.microprofile.config.inject - package org.eclipse.microprofile.config.inject
CDI Support for MicroProfile Config
org.eclipse.microprofile.config.spi - package org.eclipse.microprofile.config.spi
This package contains classes which are used to implement the configuration API, and to extend the standard configuration functionality in a portable way.

P

prefix() - Method in class org.eclipse.microprofile.config.inject.ConfigProperties.Literal
 
PROFILE - Static variable in interface org.eclipse.microprofile.config.Config
The value of the property specifies a single active profile.
PROPERTY_EXPRESSIONS_ENABLED - Static variable in interface org.eclipse.microprofile.config.Config
The value of the property determines whether the property expression is enabled or disabled.

R

registerConfig(Config, ClassLoader) - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
Register the given Config instance to the application identified by the given class loader.
releaseConfig(Config) - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
A Config normally gets released if the Application it is associated with gets destroyed.

S

setInstance(ConfigProviderResolver) - Static method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
Set the instance.

U

UNCONFIGURED_PREFIX - Static variable in annotation type org.eclipse.microprofile.config.inject.ConfigProperties
 
UNCONFIGURED_VALUE - Static variable in annotation type org.eclipse.microprofile.config.inject.ConfigProperty
 
unwrap(Class<T>) - Method in interface org.eclipse.microprofile.config.Config
Returns an instance of the specific class, to allow access to the provider specific API.

W

withConverter(Class<T>, int, Converter<T>) - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Add the specified Converter instance for the given type to the configuration being built.
withConverters(Converter<?>...) - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Add the specified Converter instances to the configuration being built.
withSources(ConfigSource...) - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Add the specified ConfigSource instances to the configuration being built.
A B C D F G I N O P R S U W 
Skip navigation links

MicroProfile Config API v3.0.1

Copyright © 2016 – 2021 Eclipse Foundation. All rights reserved.
Use is subject to license terms.