org.yarnandtail.andhow.load

Class FixedValueLoader

java.lang.Object

org.yarnandtail.andhow.load.BaseLoader

org.yarnandtail.andhow.load.FixedValueLoader

All Implemented Interfaces:

Loader

public class FixedValueLoader
extends BaseLoader

A utility loader that is used internally to put fixed values into the effective list of values. This loader does not trim incoming values for String type properties - they are assumed to already be in final form. This loader considers it a problem to be passed unrecognized properties and will throw a RuntimeException if that happens.

Author:

eeverman

Constructor Summary

Constructors

Constructor and Description
FixedValueLoader(List<PropertyValue> values)
FixedValueLoader(PropertyValue... values)

Method Summary

Modifier and Type	Method and Description
String	getLoaderDialect() The type dialect of the loader.
String	getLoaderType() The type of the loader, such as JNDI, PropertyFile, SystemProperty, etc..
String	getSpecificLoadDescription() For this particular load, where was info loaded from? This may vary from run to run based on config params.
boolean	isTrimmingRequiredForStringValues() If true, values for string properties are trimmed by the Trimmer of the property they are associated with.
boolean	isUnrecognizedPropertyNamesConsideredAProblem() If true, an unrecognized name is considered a problem that will stop application startup.
LoaderValues	load(ConstructionDefinition appConfigDef, ValueMapWithContext existingValues) Builds up a list of LoaderValues by loading property values from a configuration source.

Methods inherited from class org.yarnandtail.andhow.load.BaseLoader

attemptToAdd, attemptToAdd, createValue, findDuplicateProperty, getClassConfig, getConfigSamplePrinter, getInstanceConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedValueLoader

public FixedValueLoader(List<PropertyValue> values)

FixedValueLoader

public FixedValueLoader(PropertyValue... values)

Method Detail

load

public LoaderValues load(ConstructionDefinition appConfigDef,
                         ValueMapWithContext existingValues)

Description copied from interface: Loader

Builds up a list of LoaderValues by loading property values from a configuration source.

Returns:

isTrimmingRequiredForStringValues

public boolean isTrimmingRequiredForStringValues()

Description copied from interface: Loader

If true, values for string properties are trimmed by the Trimmer of the property they are associated with. If false, no trimming is done. Non-String type property values (like Integer or Date type values) are not affected by this. Loaders that read from text files need to trim values to separate white space and carriage returns from the value. Loaders that read from more tightly defined sources, like reading properties from java.lang.System.getProperties(), can assume that trimming has already happened.

Returns:

isUnrecognizedPropertyNamesConsideredAProblem

public boolean isUnrecognizedPropertyNamesConsideredAProblem()

Description copied from interface: Loader

If true, an unrecognized name is considered a problem that will stop application startup. This is a safety feature because a unrecognized property name in a properties file could be a typo. For other property sources, however, like System.properties, there are many non-AndHow related values that are expected to be present, so this rule cannot be enforced.

Returns:

getSpecificLoadDescription

public String getSpecificLoadDescription()

Description copied from interface: Loader

For this particular load, where was info loaded from? This may vary from run to run based on config params. For instance, The PropFileLoader will look multiple places to find a properties file. This method should return the actual location it was found. Assume the text is prefixed with "This loader loaded from: ". An example would be "/home/user/config/my-props.properties" No ending punctuation should be used.

Returns:

getLoaderType

public String getLoaderType()

Description copied from interface: Loader

The type of the loader, such as JNDI, PropertyFile, SystemProperty, etc.. The actual return value is arbitrary, but should be consistent between loaders of the same type. The values returned by getLoaderType and getLoaderDialect are used to removed duplicate loader types when printing sample files. If two loader instances are of the same type and dialect, only one will print the sample file.

Returns:

Must never returns null.

getLoaderDialect

public String getLoaderDialect()

Description copied from interface: Loader

The type dialect of the loader. For property files, this might be either KeyValuePair or xml for example. The actual return value is arbitrary, but should be consistent between loaders of the same type and dialect. The values returned by getLoaderType and getLoaderDialect are used to removed duplicate loader types when printing sample files. If two loader instances are of the same type and dialect, only one will print the sample file.

Returns:

May return null if there is no meaningful dialect for this type.