ConfigDataEnvironmentPostProcessor (spring-boot 2.6.0)

java.lang.Object
- org.springframework.boot.context.config.ConfigDataEnvironmentPostProcessor

All Implemented Interfaces:

EnvironmentPostProcessor, org.springframework.core.Ordered
```
public class ConfigDataEnvironmentPostProcessor
extends java.lang.Object
implements EnvironmentPostProcessor, org.springframework.core.Ordered
```
EnvironmentPostProcessor that loads and applies ConfigData to Spring's Environment.

Since:

2.4.0

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ON_LOCATION_NOT_FOUND_PROPERTY` Property used to determine what action to take when a `ConfigDataLocationNotFoundException` is thrown.
`static int`	`ORDER` The default order for the processor.

Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors
Constructor and Description
`ConfigDataEnvironmentPostProcessor(DeferredLogFactory logFactory, ConfigurableBootstrapContext bootstrapContext)`
`ConfigDataEnvironmentPostProcessor(DeferredLogFactory logFactory, ConfigurableBootstrapContext bootstrapContext, ConfigDataEnvironmentUpdateListener environmentUpdateListener)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`applyTo(org.springframework.core.env.ConfigurableEnvironment environment)` Apply `ConfigData` post-processing to an existing `Environment`.
`static void`	`applyTo(org.springframework.core.env.ConfigurableEnvironment environment, org.springframework.core.io.ResourceLoader resourceLoader, ConfigurableBootstrapContext bootstrapContext, java.util.Collection<java.lang.String> additionalProfiles)` Apply `ConfigData` post-processing to an existing `Environment`.
`static void`	`applyTo(org.springframework.core.env.ConfigurableEnvironment environment, org.springframework.core.io.ResourceLoader resourceLoader, ConfigurableBootstrapContext bootstrapContext, java.util.Collection<java.lang.String> additionalProfiles, ConfigDataEnvironmentUpdateListener environmentUpdateListener)` Apply `ConfigData` post-processing to an existing `Environment`.
`static void`	`applyTo(org.springframework.core.env.ConfigurableEnvironment environment, org.springframework.core.io.ResourceLoader resourceLoader, ConfigurableBootstrapContext bootstrapContext, java.lang.String... additionalProfiles)` Apply `ConfigData` post-processing to an existing `Environment`.
`int`	`getOrder()`
`void`	`postProcessEnvironment(org.springframework.core.env.ConfigurableEnvironment environment, SpringApplication application)` Post-process the given `environment`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ORDER
```
public static final int ORDER
```
    The default order for the processor.
    
    See Also:
    
    Constant Field Values
  - ON_LOCATION_NOT_FOUND_PROPERTY
```
public static final java.lang.String ON_LOCATION_NOT_FOUND_PROPERTY
```
    Property used to determine what action to take when a ConfigDataLocationNotFoundException is thrown.
    
    See Also:
    
    ConfigDataNotFoundAction, Constant Field Values
- Constructor Detail
  - ConfigDataEnvironmentPostProcessor
```
public ConfigDataEnvironmentPostProcessor(DeferredLogFactory logFactory,
                                          ConfigurableBootstrapContext bootstrapContext)
```
  - ConfigDataEnvironmentPostProcessor
```
public ConfigDataEnvironmentPostProcessor(DeferredLogFactory logFactory,
                                          ConfigurableBootstrapContext bootstrapContext,
                                          ConfigDataEnvironmentUpdateListener environmentUpdateListener)
```
- Method Detail
  - getOrder
```
public int getOrder()
```
    Specified by:
    
    getOrder in interface org.springframework.core.Ordered
  - postProcessEnvironment
```
public void postProcessEnvironment(org.springframework.core.env.ConfigurableEnvironment environment,
                                   SpringApplication application)
```
    Description copied from interface: EnvironmentPostProcessor
    
    Post-process the given environment.
    
    Specified by:
    
    postProcessEnvironment in interface EnvironmentPostProcessor
    
    Parameters:
    
    environment - the environment to post-process
    
    application - the application to which the environment belongs
  - applyTo
```
public static void applyTo(org.springframework.core.env.ConfigurableEnvironment environment)
```
    Apply ConfigData post-processing to an existing Environment. This method can be useful when working with an Environment that has been created directly and not necessarily as part of a SpringApplication.
    
    Parameters:
    
    environment - the environment to apply ConfigData to
  - applyTo
```
public static void applyTo(org.springframework.core.env.ConfigurableEnvironment environment,
                           org.springframework.core.io.ResourceLoader resourceLoader,
                           ConfigurableBootstrapContext bootstrapContext,
                           java.lang.String... additionalProfiles)
```
    Apply ConfigData post-processing to an existing Environment. This method can be useful when working with an Environment that has been created directly and not necessarily as part of a SpringApplication.
    
    Parameters:
    
    environment - the environment to apply ConfigData to
    
    resourceLoader - the resource loader to use
    
    bootstrapContext - the bootstrap context to use or null to use a throw-away context
    
    additionalProfiles - any additional profiles that should be applied
  - applyTo
```
public static void applyTo(org.springframework.core.env.ConfigurableEnvironment environment,
                           org.springframework.core.io.ResourceLoader resourceLoader,
                           ConfigurableBootstrapContext bootstrapContext,
                           java.util.Collection<java.lang.String> additionalProfiles)
```
    Apply ConfigData post-processing to an existing Environment. This method can be useful when working with an Environment that has been created directly and not necessarily as part of a SpringApplication.
    
    Parameters:
    
    environment - the environment to apply ConfigData to
    
    resourceLoader - the resource loader to use
    
    bootstrapContext - the bootstrap context to use or null to use a throw-away context
    
    additionalProfiles - any additional profiles that should be applied
  - applyTo
```
public static void applyTo(org.springframework.core.env.ConfigurableEnvironment environment,
                           org.springframework.core.io.ResourceLoader resourceLoader,
                           ConfigurableBootstrapContext bootstrapContext,
                           java.util.Collection<java.lang.String> additionalProfiles,
                           ConfigDataEnvironmentUpdateListener environmentUpdateListener)
```
    Apply ConfigData post-processing to an existing Environment. This method can be useful when working with an Environment that has been created directly and not necessarily as part of a SpringApplication.
    
    Parameters:
    
    environment - the environment to apply ConfigData to
    
    resourceLoader - the resource loader to use
    
    bootstrapContext - the bootstrap context to use or null to use a throw-away context
    
    additionalProfiles - any additional profiles that should be applied
    
    environmentUpdateListener - optional ConfigDataEnvironmentUpdateListener that can be used to track Environment updates.

Class ConfigDataEnvironmentPostProcessor

Field Summary

Fields inherited from interface org.springframework.core.Ordered

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ORDER

ON_LOCATION_NOT_FOUND_PROPERTY

Constructor Detail

ConfigDataEnvironmentPostProcessor

ConfigDataEnvironmentPostProcessor

Method Detail

getOrder

postProcessEnvironment

applyTo

applyTo

applyTo

applyTo