org.yarnandtail.andhow.load

Class PropFileBaseLoader

java.lang.Object

org.yarnandtail.andhow.load.BaseLoader

org.yarnandtail.andhow.load.PropFileBaseLoader

All Implemented Interfaces:

Loader, LocalFileLoader, ReadLoader

Direct Known Subclasses:

PropFileOnClasspathLoader, PropFileOnFilesystemLoader

public abstract class PropFileBaseLoader
extends BaseLoader
implements ReadLoader, LocalFileLoader

Shared functionality for all Property file loaders.

Author:

ericeverman

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	missingFileAProblem
protected Property<String>	pathProp Property containing the path of a property file.
protected String	pathStr String containing path of a property file.
protected boolean	unknownPropertyAProblem

Constructor Summary

Constructors

Constructor and Description
PropFileBaseLoader()

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.
protected String	getEffectivePath(ValidatedValuesWithContext existingValues) Utility method to simplify finding the effective path.
List<Property>	getInstanceConfig() A list of properties that the user has specified as being configuration properties 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	isFlaggable() Returns true if this loader supports FlaggableType's.
boolean	isMissingFileAProblem() If true, a loader that loads from a file will report a Problem that will stop application startup if it cannot find the configured file.
boolean	isTrimmingRequiredForStringValues() If true, values for string properties are trimmed by the Trimmer of the property they are associated with.
boolean	isUnknownPropertyAProblem() If true, an unrecognized name is considered a problem that will stop application startup.
LoaderValues	loadInputStreamToProps(InputStream inputStream, String fromPath, PropertyConfigurationInternal appConfigDef, ValidatedValuesWithContext existingValues)
void	setFilePath(Property<String> path) Sets the path to the file to be loaded.
void	setFilePath(String path) Sets the path to the file to be loaded.
void	setMissingFileAProblem(boolean isAProblem) If set true, a file path that does not point to a file is a Problem/error.
void	setUnknownPropertyAProblem(boolean isAProblem) If true, an unrecognized property name is considered a problem/error.

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, getSpecificLoadDescription, load, releaseResources

Field Detail

pathProp

protected Property<String> pathProp

Property containing the path of a property file. XOR w/ classpathStr

pathStr

protected String pathStr

String containing path of a property file. XOR w/ classpathProp

missingFileAProblem

protected boolean missingFileAProblem

unknownPropertyAProblem

protected boolean unknownPropertyAProblem

Constructor Detail

PropFileBaseLoader

public PropFileBaseLoader()

Method Detail

loadInputStreamToProps

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

Throws:

org.yarnandtail.andhow.load.LoaderException

getEffectivePath

protected String getEffectivePath(ValidatedValuesWithContext existingValues)

Utility method to simplify finding the effective path.

Parameters:

existingValues -

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.

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.

Specified by:

isTrimmingRequiredForStringValues in interface Loader

Returns:

isFlaggable

public boolean isFlaggable()

Description copied from interface: Loader

Returns true if this loader supports FlaggableType's.

Loaders that support FlaggableType give special 'is present' meaning to a property being present without a value, similar to a 'nix command line flag. If a Loader supports flags, it should call FlaggableType.parseFlag(String) instead of ValueType.parse(String) when a Property's ValueType is a FlaggableType. See FlagProp for an example type.

Note: Returning true from this method is only potentially applicable to Loaders that parse strings. Loaders that directly load from rich values do not parse, so the loader logic would ignore the value here.

Examples:
Loading a non-null value from the properties file entry 'name = ' would be unexpected, so a properties file Loader should return 'false' here.
However, a command line loader would be expected to support flags, so should return 'true'.

Specified by:

isFlaggable in interface Loader

Returns:

true if this loader support 'nix style flag semantics for FlaggableType Properties.

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.

Specified by:

getLoaderType in interface Loader

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.

Specified by:

getLoaderDialect in interface Loader

Returns:

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

setUnknownPropertyAProblem

public void setUnknownPropertyAProblem(boolean isAProblem)

Description copied from interface: ReadLoader

If true, an unrecognized property name is considered a problem/error.

Specified by:

setUnknownPropertyAProblem in interface ReadLoader

isUnknownPropertyAProblem

public boolean isUnknownPropertyAProblem()

Description copied from interface: ReadLoader

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.

Specified by:

isUnknownPropertyAProblem in interface ReadLoader

Returns:

setMissingFileAProblem

public void setMissingFileAProblem(boolean isAProblem)

Description copied from interface: LocalFileLoader

If set true, a file path that does not point to a file is a Problem/error. A null file path is not a problem, effectively turning off the loader.

Specified by:

setMissingFileAProblem in interface LocalFileLoader

isMissingFileAProblem

public boolean isMissingFileAProblem()

Description copied from interface: LocalFileLoader

If true, a loader that loads from a file will report a Problem that will stop application startup if it cannot find the configured file.

Specified by:

isMissingFileAProblem in interface LocalFileLoader

Returns:

setFilePath

public void setFilePath(String path)

Description copied from interface: LocalFileLoader

Sets the path to the file to be loaded. Setting this non-null is mutually exclusive with setting the Property<String> based method of the same name.

Specified by:

setFilePath in interface LocalFileLoader

setFilePath

public void setFilePath(Property<String> path)

Description copied from interface: LocalFileLoader

Sets the path to the file to be loaded. Setting this non-null is mutually exclusive with setting the String based method of the same name.

Specified by:

setFilePath in interface LocalFileLoader