org.yarnandtail.andhow.load

Class PropFileOnClasspathLoader

java.lang.Object

org.yarnandtail.andhow.load.BaseLoader

org.yarnandtail.andhow.load.PropFileBaseLoader

org.yarnandtail.andhow.load.PropFileOnClasspathLoader

All Implemented Interfaces:

Loader, LocalFileLoader, ReadLoader

Direct Known Subclasses:

StdPropFileOnClasspathLoader

public class PropFileOnClasspathLoader
extends PropFileBaseLoader

Reads from a Java .properties file on the classpath, following standard java conventions for the structure of those key:value pair files. This loader finds the properties file via either a String or StrProperty specified in the constructor. If the StrProperty is used, an earlier an earlier loading loader must have found a value for that property if it is to be used. Assigning or configuring a null classpath effectively turns off this loader. This loader trims incoming values for String type properties using the Trimmer of the associated Property. For strings, this is the QuotedStringTrimmer by default, which will preserve whitespace if wrapped in double quotes. 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. The PropFileLoader is 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.

Field Summary

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

missingFileAProblem, pathProp, pathStr, unknownPropertyAProblem

Constructor Summary

Constructors

Constructor and Description
PropFileOnClasspathLoader()

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(PropertyConfigurationInternal appConfigDef, LoaderEnvironment environment, ValidatedValuesWithContext existingValues) Builds up a list of LoaderValues by loading property values from a configuration source.
LoaderValues	load(PropertyConfigurationInternal appConfigDef, ValidatedValuesWithContext existingValues, String path) Load from a non-null classpathProp path.

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

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

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

attemptToAdd, attemptToAdd, attemptToAdd, attemptToAddIfNotDuplicate, createValue, findDuplicateProperty, getClassConfig, mapNametoProperty, 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

PropFileOnClasspathLoader

public PropFileOnClasspathLoader()

Method Detail

load

public LoaderValues load(PropertyConfigurationInternal appConfigDef,
                         LoaderEnvironment environment,
                         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.

Parameters:

appConfigDef - The definition of all known Properties and naming metadata.

environment - The environment (System Props, Env vars, fixed values) as known to the Loader.

existingValues - The values already set by prior loaders, which may configure the behavior of this loader.

Returns:

The Property values loaded by this loader and/or the problems discovered while attempting to load those Property values.

load

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

Load from a non-null classpathProp path.

Parameters:

appConfigDef -

existingValues -

path -

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: