org.yarnandtail.andhow.load

Class PropFileOnFilesystemLoader

java.lang.Object

org.yarnandtail.andhow.load.BaseLoader

org.yarnandtail.andhow.load.PropFileBaseLoader

org.yarnandtail.andhow.load.PropFileOnFilesystemLoader

All Implemented Interfaces:

Loader, LocalFileLoader, ReadLoader

Direct Known Subclasses:

StdPropFileOnFilesystemLoader

public class PropFileOnFilesystemLoader
extends PropFileBaseLoader

Reads from a Java .property file from the filesystem, following standard java conventions for the structure of those file. This loader finds the properties file to load properties from based on a file path property passed in its constructor. If this loader is to read that property, an earlier loader must have loaded a value for it. It is not considered an error if the file path property has not been assigned a value. This loader trims incoming values for String type properties using the Trimmer of the associated Property. Properties File Loaders use the java.util.Properties class to read properties, so several behaviors are determined by that class. By default, this loader considers it a problem not find a configured file or to find unrecognized properties in a properties file and will throw a RuntimeException if that happens. Property File Loaders are unable to detect duplicate properties (i.e., the same key value appearing more than once in a prop file). Instead of aborting the application startup with an error, only the last of the property values in the file is assigned. This is a basic limitation of the JVM Properties class, which silently ignores multiple entries, each value overwriting the last.

Author:

eeverman

Field Summary

Fields inherited from class org.yarnandtail.andhow.load.PropFileBaseLoader

missingFileAProblem, pathProp, pathStr, unknownPropertyAProblem

Constructor Summary

Constructors

Constructor and Description
PropFileOnFilesystemLoader()

Method Summary

Modifier and Type	Method and Description
String	getSpecificLoadDescription() For this particular load, where was info loaded from? This may vary from run to run based on config params.
LoaderValues	load(StaticPropertyConfigurationInternal appConfigDef, ValidatedValuesWithContext existingValues) Builds up a list of LoaderValues by loading property values from a configuration source.
LoaderValues	load(StaticPropertyConfigurationInternal appConfigDef, ValidatedValuesWithContext existingValues, String path)

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

getConfigSamplePrinter, getEffectivePath, getInstanceConfig, getLoaderDialect, getLoaderType, isMissingFileAProblem, isTrimmingRequiredForStringValues, isUnknownPropertyAProblem, loadInputStreamToProps, setFilePath, setFilePath, setMissingFileAProblem, setUnknownPropertyAProblem

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

attemptToAdd, attemptToAdd, createValue, findDuplicateProperty, getClassConfig, releaseResources

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yarnandtail.andhow.api.Loader

getClassConfig, releaseResources

Constructor Detail

PropFileOnFilesystemLoader

public PropFileOnFilesystemLoader()

Method Detail

load

public LoaderValues load(StaticPropertyConfigurationInternal appConfigDef,
                         ValidatedValuesWithContext existingValues)

Description copied from interface: Loader

Builds up a list of LoaderValues by loading property values from a configuration source. Loaders find and load values and associate them with the correct Property. If there is a problem while doing that, they register one or more LoaderProblems in the returned LoaderValues. Validation of Property values is not Loader's responsibility and will be handled outside this method.

Returns:

load

public LoaderValues load(StaticPropertyConfigurationInternal appConfigDef,
                         ValidatedValuesWithContext existingValues,
                         String path)

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: