Package com.helger.config.source.resource

Interface IConfigurationSourceResource

All Superinterfaces:

IConfigurationSource, IConfigurationValueProvider, IIterableConfigurationSource

All Known Implementing Classes:

AbstractConfigurationSourceResource, ConfigurationSourceProperties

public interface IConfigurationSourceResource
extends IIterableConfigurationSource

Specific configuration source based on a readable resource.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
com.helger.collection.commons.ICommonsOrderedMap<String,String>	getAllConfigItems()
com.helger.io.resource.IReadableResource	getResource()
com.helger.base.state.ESuccess	reload()	Try to reload the configuration source from the configured resource.

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

getPriority, getSourceType, isInitializedAndUsable

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

getConfigurationValue

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

getAllConfiguredValues

Method Details

getResource

@Nonnull
com.helger.io.resource.IReadableResource getResource()

Returns:

The resource of this configuration source. Never null.

reload

@Nonnull
com.helger.base.state.ESuccess reload()

Try to reload the configuration source from the configured resource. The reloading should be an atomic operation and be thread-safe.

Returns:

ESuccess.SUCCESS if the resource was found and loaded, ESuccess.FAILURE otherwise.

Since:

9.4.5

getAllConfigItems

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

Specified by:

getAllConfigItems in interface IIterableConfigurationSource

Returns:

An ordered map of all contained keys and values in this resource. The order of the items should follow the order of their declaration in the underlying resource. Never null but maybe empty.

Since:

9.4.3