org.yarnandtail.andhow.internal

Class ValueMapImmutable

java.lang.Object

org.yarnandtail.andhow.internal.ValueMapImmutable

All Implemented Interfaces:

ValueMap

public class ValueMapImmutable
extends Object
implements ValueMap

Author:

eeverman

Constructor Summary

Constructors

Constructor and Description
ValueMapImmutable(Map<Property<?>,Object> loadedValues)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueMapImmutable

public ValueMapImmutable(Map<Property<?>,Object> loadedValues)

Method Detail

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.

Specified by:

getExplicitValue in interface ValueMap

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).

Specified by:

getEffectiveValue in interface ValueMap

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.

Specified by:

isExplicitlySet in interface ValueMap

Parameters:

prop - The property to check

Returns:

True if this value is explicitly set.