org.yarnandtail.andhow.internal

Class ValueMapWithContextMutable

java.lang.Object

org.yarnandtail.andhow.internal.ValueMapWithContextBase

org.yarnandtail.andhow.internal.ValueMapWithContextMutable

All Implemented Interfaces:

ValueMap, ValueMapWithContext

public class ValueMapWithContextMutable
extends ValueMapWithContextBase

Author:

eeverman

Constructor Summary

Constructors

Constructor and Description
ValueMapWithContextMutable()

Method Summary

Modifier and Type	Method and Description
void	addValues(LoaderValues values)
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.
<T> T	getEffectiveValue(Property<T> prop) The explicitly value, or if that is null, the default (which may also be null).
LoaderValues	getEffectiveValuesLoadedByLoader(Loader loader) The list of Properties and values loaded by the specified loader that were not overridden by earlier Loaders.
<T> T	getExplicitValue(Property<T> prop) Get a value explicitly configured.
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).
boolean	isExplicitlySet(Property<?> prop) Returns true if the Property's value was explicitly set via one of the loaders.

Methods inherited from class org.yarnandtail.andhow.internal.ValueMapWithContextBase

buildValueMapImmutable, getAllValuesLoadedByLoader, getEffectiveValue, getEffectiveValuesLoadedByLoader, getValue, isPropertyPresent

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueMapWithContextMutable

public ValueMapWithContextMutable()

Method Detail

addValues

public void addValues(LoaderValues values)

getValueMapWithContextImmutable

public ValueMapWithContext getValueMapWithContextImmutable()

Description copied from interface: ValueMapWithContext

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:

getExplicitValue

public <T> T getExplicitValue(Property<T> prop)

Description copied from interface: ValueMap

Get a value explicitly configured. If not configured via one of the Loaders, null is returned, not the default value.

Type Parameters:

T - prop The property to get the value for

Returns:

The value, if explicitly set, or null if not explicity set.

getEffectiveValue

public <T> T getEffectiveValue(Property<T> prop)

Description copied from interface: ValueMap

The explicitly value, or if that is null, the default (which may also be null).

Parameters:

prop - The property to get the value for.

Returns:

The explicit value or, if no explicit, the default value. Otherwise null.

isExplicitlySet

public boolean isExplicitlySet(Property<?> prop)

Description copied from interface: ValueMap

Returns true if the Property's value was explicitly set via one of the loaders. At the moment, that means it would also return a non-null value, however, future versions may support explicit nulls.

Parameters:

prop - The property to check

Returns:

True if this value is explicitly set.

getAllLoaderValues

public List<LoaderValues> getAllLoaderValues()

Description copied from interface: ValueMapWithContext

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

Returns:

getAllValuesLoadedByLoader

public LoaderValues getAllValuesLoadedByLoader(Loader loader)

Description copied from interface: ValueMapWithContext

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.

Returns:

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

getEffectiveValuesLoadedByLoader

public LoaderValues getEffectiveValuesLoadedByLoader(Loader loader)

Description copied from interface: ValueMapWithContext

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.

Returns:

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

getValueMapImmutable

public ValueMap getValueMapImmutable()

Description copied from interface: ValueMapWithContext

Unmodifiable minimum data for Properties to retrieve their data from.

Returns:

hasProblems

public boolean hasProblems()

Description copied from interface: ValueMapWithContext

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

Returns: