org.yarnandtail.andhow.api

Interface ValueMap

All Known Subinterfaces:

ValueMapWithContext

All Known Implementing Classes:

AndHow, AndHowCore, LoaderValues, ValueMapImmutable, ValueMapWithContextBase, ValueMapWithContextImmutable, ValueMapWithContextMutable

public interface ValueMap

The values that are loaded or otherwise specified for a set of Properties in a AndHow. This is basically a dedicated Map with Property keys and their associated values. Not all Properties will be in the map, only the ones which have a value specified. During runtime, an immutable instance of this class contains all the needed information to map Properties to their values.

Author:

eeverman

Method Summary

Modifier and Type	Method and Description
<T> T	getEffectiveValue(Property<T> prop) The explicitly value, or if that is null, the default (which may also be null).
<T> T	getExplicitValue(Property<T> prop) Get a value explicitly configured.
boolean	isExplicitlySet(Property<?> prop) Returns true if the Property's value was explicitly set via one of the loaders.

Method Detail

getExplicitValue

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

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

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

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

boolean isExplicitlySet(Property<?> prop)

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.