Class FilePropertySourceImporter

java.lang.Object

io.micronaut.context.env.FilePropertySourceImporter

All Implemented Interfaces:

PropertySourceImporter<FilePropertySourceImporter.FileImport>, Toggleable, AutoCloseable

public final class FilePropertySourceImporter
extends Object
implements PropertySourceImporter<FilePropertySourceImporter.FileImport>

Imports property sources from file system locations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FilePropertySourceImporter.FileImport	Typed file import declaration.

Nested classes/interfaces inherited from interface PropertySourceImporter

PropertySourceImporter.ImportContext<T>

Constructor Summary

Constructors

Constructor	Description
FilePropertySourceImporter()

Method Summary

Modifier and Type	Method	Description
String	getProvider()
Optional<PropertySource>	importPropertySource(PropertySourceImporter.ImportContext<FilePropertySourceImporter.FileImport> context)	Resolve a property source from the provided context.
FilePropertySourceImporter.FileImport	newImportDeclaration(ConvertibleValues<Object> values)	Convert structured config import values into a type-safe import declaration consumed by this importer.
FilePropertySourceImporter.FileImport	newImportDeclaration(ConnectionString connectionString)	Convert the raw connection string into a type-safe import declaration consumed by this importer.

Methods inherited from class Object

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

Methods inherited from interface PropertySourceImporter

close

Methods inherited from interface Toggleable

isEnabled

Constructor Details

FilePropertySourceImporter

public FilePropertySourceImporter()

Method Details

getProvider

public String getProvider()

Specified by:

getProvider in interface PropertySourceImporter<FilePropertySourceImporter.FileImport>

Returns:

The provider this importer supports.

newImportDeclaration

public FilePropertySourceImporter.FileImport newImportDeclaration(ConnectionString connectionString)

Description copied from interface: PropertySourceImporter

Convert the raw connection string into a type-safe import declaration consumed by this importer.

Micronaut invokes this method once for each scalar micronaut.config.import entry before calling PropertySourceImporter.importPropertySource(ImportContext). Implementations should validate any importer-specific semantics here and return an immutable declaration value suitable for repeated reads within the same load cycle.

Specified by:

newImportDeclaration in interface PropertySourceImporter<FilePropertySourceImporter.FileImport>

Parameters:

connectionString - The parsed connection string declaration

Returns:

The typed import declaration

newImportDeclaration

public FilePropertySourceImporter.FileImport newImportDeclaration(ConvertibleValues<Object> values)

Description copied from interface: PropertySourceImporter

Convert structured config import values into a type-safe import declaration consumed by this importer.

Micronaut invokes this method for map-based micronaut.config.import declarations after resolving the required provider field. Implementations should validate required keys and throw a configuration exception if the declaration is invalid.

Specified by:

newImportDeclaration in interface PropertySourceImporter<FilePropertySourceImporter.FileImport>

Parameters:

values - The structured config import values

Returns:

The typed import declaration

importPropertySource

public Optional<PropertySource> importPropertySource(PropertySourceImporter.ImportContext<FilePropertySourceImporter.FileImport> context)

Description copied from interface: PropertySourceImporter

Resolve a property source from the provided context.

Specified by:

importPropertySource in interface PropertySourceImporter<FilePropertySourceImporter.FileImport>

Parameters:

context - The import context

Returns:

The imported property source