org.yarnandtail.andhow.load.std

Class StdEnvVarLoader

java.lang.Object

org.yarnandtail.andhow.load.BaseLoader

org.yarnandtail.andhow.load.MapLoader

org.yarnandtail.andhow.load.std.StdEnvVarLoader

All Implemented Interfaces:

Loader, ReadLoader, StandardLoader

public class StdEnvVarLoader
extends MapLoader
implements StandardLoader

Loads properties from java.lang.System.getenv(). The System environment variables are variables provided by the host environment. They may contain system information and can also be used to pass custom user variables from the host system to the JVM.

Author:

eeverman

Field Summary

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

map, unknownPropertyAProblem

Constructor Summary

Constructors

Constructor and Description
StdEnvVarLoader()

Method Summary

Modifier and Type	Method and Description
String	getLoaderType() The type of the loader, such as JNDI, PropertyFile, SystemProperty, etc..
Map<?,?>	getMap()
String	getSpecificLoadDescription() For this particular load, where was info loaded from? This may vary from run to run based on config params.
boolean	isTrimmingRequiredForStringValues() If true, values for string properties are trimmed by the Trimmer of the property they are associated with.

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

getLoaderDialect, isUnknownPropertyAProblem, load, releaseResources, setMap, setUnknownPropertyAProblem

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

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

getClassConfig, getConfigSamplePrinter, getInstanceConfig, getLoaderDialect, load, releaseResources

Constructor Detail

StdEnvVarLoader

public StdEnvVarLoader()

Method Detail

getMap

public Map<?,?> getMap()

Overrides:

getMap in class MapLoader

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.

Specified by:

getSpecificLoadDescription in interface Loader

Overrides:

getSpecificLoadDescription in class MapLoader

Returns:

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

Overrides:

isTrimmingRequiredForStringValues in class MapLoader

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

Overrides:

getLoaderType in class MapLoader

Returns:

Must never returns null.