org.yarnandtail.andhow.internal

Class ValidatedValuesWithContextMutable

java.lang.Object

org.yarnandtail.andhow.internal.ValidatedValuesWithContextBase

org.yarnandtail.andhow.internal.ValidatedValuesWithContextMutable

All Implemented Interfaces:

ValidatedValues, ValidatedValuesWithContext

public class ValidatedValuesWithContextMutable
extends ValidatedValuesWithContextBase

Mutable ValidatedValues implementation w/ context info.

Author:

eeverman

Constructor Summary

Constructors

Constructor and Description
ValidatedValuesWithContextMutable()

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.
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) The value found and loaded for this value by a Loader.
<T> T	getValue(Property<T> prop) The effective value, similar to Property.getValue, but specifically for the context of this ValueMap.
ValidatedValues	getValueMapImmutable() Unmodifiable minimum data for Properties to retrieve their data from.
ValidatedValuesWithContext	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) True if the Property's value is explicitly set to a non-null value via one of the loaders.

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

buildValueMapImmutable, getAllValuesLoadedByLoader, getEffectiveValue, getEffectiveValuesLoadedByLoader, getExplicitValue, isPropertyPresent

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidatedValuesWithContextMutable

public ValidatedValuesWithContextMutable()

Method Detail

addValues

public void addValues(LoaderValues values)

getValueMapWithContextImmutable

public ValidatedValuesWithContext getValueMapWithContextImmutable()

Description copied from interface: ValidatedValuesWithContext

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: ValidatedValues

The value found and loaded for this value by a Loader. If no non-null value was found by a loader for this property, null is returned.

Type Parameters:

T - The return type of the Property.

Parameters:

prop - The property to get the value for

Returns:

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

getValue

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

Description copied from interface: ValidatedValues

The effective value, similar to Property.getValue, but specifically for the context of this ValueMap. The effective value is the explicitly configured value, or if that is null, the default value. Explicitly setting a property to null is not possible because it will just be ignored and the default used instead.

Type Parameters:

T - The return type of the Property.

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: ValidatedValues

True if the Property's value is explicitly set to a non-null value via one of the loaders.

Parameters:

prop - The property to check

Returns:

True if this value is explicitly set.

getAllLoaderValues

public List<LoaderValues> getAllLoaderValues()

Description copied from interface: ValidatedValuesWithContext

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

Returns:

getAllValuesLoadedByLoader

public LoaderValues getAllValuesLoadedByLoader(Loader loader)

Description copied from interface: ValidatedValuesWithContext

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: ValidatedValuesWithContext

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 ValidatedValues getValueMapImmutable()

Description copied from interface: ValidatedValuesWithContext

Unmodifiable minimum data for Properties to retrieve their data from.

Returns:

hasProblems

public boolean hasProblems()

Description copied from interface: ValidatedValuesWithContext

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

Returns: