org.yarnandtail.andhow.api

Interface ValueMapWithContext

All Superinterfaces:

ValueMap

All Known Implementing Classes:

ValueMapWithContextBase, ValueMapWithContextImmutable, ValueMapWithContextMutable

public interface ValueMapWithContext
extends ValueMap

Extention of ValueMap that adds contextual information to the ValueMap. ValueMap has all the needed info to provide values for Proerties during runtime. This class provides more metadata, such as where a value was loaded from, if there are Problems encountered during value loading and which values were loaded by which Loader, etc.. During startup, a mutable version of ValueMapWithContext if incrementally loaded with values and reported issues. After loading is complete, values are copied to immutable versions of ValueMap and ValueMapWithContext. ValueMap is used to fetch values as needed, ValueMapWithContext provides metadata on values if needed.

Author:

eeverman

Method Summary

Modifier and Type	Method and Description
List<LoaderValues>	getAllLoaderValues() A sequential list of all loaders and all its values, even overwritten ones.
LoaderValues	getAllValuesLoadedByLoader(Loader loader) All the values loaded by the specified Loader, even if they were overridden by earlier loaders.
LoaderValues	getEffectiveValuesLoadedByLoader(Loader loader) The list of Properties and values loaded by the specified loader that were not overridden by earlier Loaders.
ValueMap	getValueMapImmutable() Unmodifiable minimum data for Properties to retrieve their data from.
ValueMapWithContext	getValueMapWithContextImmutable() Unmodifiable minimum data collection to store the structure of how data was loaded.
boolean	hasProblems() Returns true if any value or loader has any sort of issue (invalid value, parsing error, etc).

Methods inherited from interface org.yarnandtail.andhow.api.ValueMap

getEffectiveValue, getExplicitValue, isExplicitlySet

Method Detail

hasProblems

boolean hasProblems()

Returns true if any value or loader has any sort of issue (invalid value, parsing error, etc).

Returns:

getAllLoaderValues

List<LoaderValues> getAllLoaderValues()

A sequential list of all loaders and all its values, even overwritten ones.

Returns:

getAllValuesLoadedByLoader

LoaderValues getAllValuesLoadedByLoader(Loader loader)

All the values loaded by the specified Loader, even if they were overridden by earlier loaders. This is mostly for reporting and debugging to show the user what the loader was able to find and load.

Parameters:

loader -

Returns:

May return null if the passed Loader is not in use by AndHow.

getEffectiveValuesLoadedByLoader

LoaderValues getEffectiveValuesLoadedByLoader(Loader loader)

The list of Properties and values loaded by the specified loader that were not overridden by earlier Loaders. I.e., the values returned are actually in use. This is mostly for reporting and debugging to show the user what the loader was able to find and load.

Parameters:

loader -

Returns:

May return null if the passed Loader is not in use by AndHow.

getValueMapImmutable

ValueMap getValueMapImmutable()

Unmodifiable minimum data for Properties to retrieve their data from.

Returns:

getValueMapWithContextImmutable

ValueMapWithContext getValueMapWithContextImmutable()

Unmodifiable minimum data collection to store the structure of how data was loaded. Implementations may maintain this data in one state while loading and another once loading is done.

Returns: