org.yarnandtail.andhow.api

Class LoaderValues

java.lang.Object

org.yarnandtail.andhow.api.LoaderValues

All Implemented Interfaces:

ValidatedValues

public class LoaderValues
extends Object
implements ValidatedValues

The Properties and values loaded by a single Loader. Only Properties for which a Loader found a value will be in the collection.

Author:

eeverman

Field Summary

Fields

Modifier and Type	Field and Description
static List<ValidatedValue>	EMPTY_PROP_VALUE_LIST

Constructor Summary

Constructors

Constructor and Description
LoaderValues(Loader loader) A constructor when there is no problem, but there were no values loaded.
LoaderValues(Loader loader, List<ValidatedValue> inValues, ProblemList<Problem> problems)
LoaderValues(Loader loader, Problem problem) A constructor when there is just a problem to report.

Method Summary

Modifier and Type	Method and Description
<T> T	getExplicitValue(Property<T> prop) A linear search for the Property in the values loaded by this loader.
Loader	getLoader()
ProblemList<Problem>	getProblems() Returns loader and value problems, if any.
<T> T	getValue(Property<T> prop) The effective value, similar to Property.getValue, but specifically for the context of this ValueMap.
List<ValidatedValue>	getValues()
boolean	isExplicitlySet(Property<?> prop) A linear search for the Property in the values loaded by this loader.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_PROP_VALUE_LIST

public static final List<ValidatedValue> EMPTY_PROP_VALUE_LIST

Constructor Detail

LoaderValues

public LoaderValues(Loader loader,
                    Problem problem)

A constructor when there is just a problem to report.

Parameters:

loader -

problem -

LoaderValues

public LoaderValues(Loader loader)

A constructor when there is no problem, but there were no values loaded.

Parameters:

loader -

LoaderValues

public LoaderValues(Loader loader,
                    List<ValidatedValue> inValues,
                    ProblemList<Problem> problems)

Method Detail

getLoader

public Loader getLoader()

getValues

public List<ValidatedValue> getValues()

getExplicitValue

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

A linear search for the Property in the values loaded by this loader.

Specified by:

getExplicitValue in interface ValidatedValues

Type Parameters:

T - The return type of the Property.

Parameters:

prop -

Returns:

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.

Specified by:

getValue in interface ValidatedValues

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)

A linear search for the Property in the values loaded by this loader.

Specified by:

isExplicitlySet in interface ValidatedValues

Parameters:

prop -

Returns:

getProblems

public ProblemList<Problem> getProblems()

Returns loader and value problems, if any.

Returns:

Never null