org.yarnandtail.andhow.load

Class PropertyFileOnClasspathLoader

java.lang.Object

org.yarnandtail.andhow.load.BaseLoader

org.yarnandtail.andhow.load.PropertyFileBaseLoader

org.yarnandtail.andhow.load.PropertyFileOnClasspathLoader

All Implemented Interfaces:

Loader

public class PropertyFileOnClasspathLoader
extends PropertyFileBaseLoader

Reads from a Java .property file on the classpath, following standard java conventions for the structure of those file. This loader finds the properties file to loadJavaPropsToAndhowProps from based on a classpath property it is passed in its constructor. Since this loader expects to find a value loaded for that property, an earlier loader must have loaded a value for it. It is considered an error if its configured classpath does not point to a valid properties file. It is not considered an error if the classpath property has not been assigned a value. This loader trims incoming values for String type properties using the Trimmer of the associated Property. This loader considers it a problem to find unrecognized properties in a properties file and will throw a RuntimeException if that happens. Properties File Loaders use the java.util.Properties class to read properties, so several behaviors are determined by that class. In rare cases, whitespace handling of the JVM Properties file parser may be an issue. The property value is generally terminated by the end of the line. Whitespace following the property value is not ignored, and is treated as part of the property value. This is not a problem in most cases because by default, properties have Trimmers that remove whitespace. Other Trimmer implementations can be assigned to properties, however, so be aware of the implementations if your are using non-default Trimmers. 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.

Author:

eeverman

Constructor Summary

Constructors

Constructor and Description
PropertyFileOnClasspathLoader(StrProp classpathOfPropertyFile)

Method Summary

Modifier and Type	Method and Description
List<Property>	getInstanceConfig() A list of properties that the user has specified as being configuration properties for this Loader.
String	getSpecificLoadDescription() For this particular load, where was info loaded from? This may vary from run to run based on config params.
LoaderValues	load(ConstructionDefinition appConfigDef, ValueMapWithContext existingValues) Builds up a list of LoaderValues by loading property values from a configuration source.
LoaderValues	load(ConstructionDefinition appConfigDef, ValueMapWithContext existingValues, String path) Load from a non-null classpath path.

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

getConfigSamplePrinter, getLoaderDialect, getLoaderType, isTrimmingRequiredForStringValues, isUnrecognizedPropertyNamesConsideredAProblem, loadInputStreamToProps

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

attemptToAdd, attemptToAdd, createValue, findDuplicateProperty, getClassConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyFileOnClasspathLoader

public PropertyFileOnClasspathLoader(StrProp classpathOfPropertyFile)

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:

load

public LoaderValues load(ConstructionDefinition appConfigDef,
                         ValueMapWithContext existingValues,
                         String path)

Load from a non-null classpath path.

Parameters:

appConfigDef -

existingValues -

path -

Returns:

getInstanceConfig

public List<Property> getInstanceConfig()

Description copied from interface: Loader

A list of properties that the user has specified as being configuration properties for this Loader. Typically these Properties have been specified in the Loader constructor or builder. An example usage would be passing in a Property that specifies the location of a properties file to read from. This is the preferred way to configure a loader because its clear to the user and it allows each instance of a loader to be configured differently, e.g., so PropertyFile loaders that load from different locations. Any Properties returned from this method must have been registered for configuration.

Specified by:

getInstanceConfig in interface Loader

Overrides:

getInstanceConfig in class BaseLoader

Returns:

Never null. Either an empty list or populated.

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: