Package com.helger.config.source

Interface IIterableConfigurationSource

All Superinterfaces:

IConfigurationSource, IConfigurationValueProvider

All Known Subinterfaces:

IConfigurationSourceResource

All Known Implementing Classes:

AbstractConfigurationSourceResource, ConfigurationSourceEnvVar, ConfigurationSourceProperties, ConfigurationSourceSystemProperty

public interface IIterableConfigurationSource
extends IConfigurationSource

Interface for a configuration source that provides all its possible keys. This is an optional interface to be implemented by configuration sources supporting it.

Since:

11.0.0

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
com.helger.collection.commons.ICommonsMap<String,String>	getAllConfigItems()
default com.helger.collection.commons.ICommonsMap<String,ConfiguredValue>	getAllConfiguredValues()

Methods inherited from interface com.helger.config.source.IConfigurationSource

getPriority, getSourceType, isInitializedAndUsable

Methods inherited from interface com.helger.config.value.IConfigurationValueProvider

getConfigurationValue

Method Details

getAllConfigItems

@Nonnull
@ReturnsMutableCopy
com.helger.collection.commons.ICommonsMap<String,String> getAllConfigItems()

Returns:

A map of all contained keys with their values in this configuration source. If the underlying source uses some kind of ordering (e.g. in files), this order should be maintained. Never null but maybe empty.

getAllConfiguredValues

@Nonnull
@ReturnsMutableCopy
default com.helger.collection.commons.ICommonsMap<String,ConfiguredValue> getAllConfiguredValues()

Returns:

A map of all contained keys and ConfiguredValue in this configuration source. If the underlying source uses some kind of ordering (e.g. in files), this order should be maintained. Never null but maybe empty.

See Also:

• getAllConfigItems()