org.yarnandtail.andhow.load

Class PropertyFileBaseLoader

java.lang.Object

org.yarnandtail.andhow.load.BaseLoader

org.yarnandtail.andhow.load.PropertyFileBaseLoader

All Implemented Interfaces:

Loader

Direct Known Subclasses:

PropertyFileOnClasspathLoader, PropertyFileOnFilesystemLoader

public abstract class PropertyFileBaseLoader
extends BaseLoader

Shared functionality for all Property file loaders.

Author:

ericeverman

Constructor Summary

Constructors

Constructor and Description
PropertyFileBaseLoader()

Method Summary

Modifier and Type	Method and Description
SamplePrinter	getConfigSamplePrinter() Returns a ConfigSamplePrinter, which can be used to print a configuration sample for this Loader.
String	getLoaderDialect() The type dialect of the loader.
String	getLoaderType() The type of the loader, such as JNDI, PropertyFile, SystemProperty, etc..
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	loadInputStreamToProps(InputStream inputStream, String fromPath, ConstructionDefinition appConfigDef, ValueMapWithContext existingValues)

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

attemptToAdd, attemptToAdd, createValue, findDuplicateProperty, getClassConfig, getInstanceConfig

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

getSpecificLoadDescription, load

Constructor Detail

PropertyFileBaseLoader

public PropertyFileBaseLoader()

Method Detail

loadInputStreamToProps

public LoaderValues loadInputStreamToProps(InputStream inputStream,
                                           String fromPath,
                                           ConstructionDefinition appConfigDef,
                                           ValueMapWithContext existingValues)
                                    throws org.yarnandtail.andhow.load.LoaderException

Throws:

org.yarnandtail.andhow.load.LoaderException

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:

getConfigSamplePrinter

public SamplePrinter getConfigSamplePrinter()

Description copied from interface: Loader

Returns a ConfigSamplePrinter, which can be used to print a configuration sample for this Loader. This method may return null if there is no sample printer for this loader.

Specified by:

getConfigSamplePrinter in interface Loader

Overrides:

getConfigSamplePrinter in class BaseLoader

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.