org.yarnandtail.andhow.load.std

Class StdFixedValueLoader

java.lang.Object

org.yarnandtail.andhow.load.BaseLoader

org.yarnandtail.andhow.load.FixedValueLoader

org.yarnandtail.andhow.load.std.StdFixedValueLoader

All Implemented Interfaces:

Loader, ReadLoader, StandardLoader

public class StdFixedValueLoader
extends FixedValueLoader
implements StandardLoader

Sets values directly in code.

Position in Standard Loading Order, first to last

• StdFixedValueLoader <-- This loader
• StdMainStringArgsLoader
• StdSysPropLoader
• StdEnvVarLoader
• StdJndiLoader
• StdPropFileOnFilesystemLoader
• StdPropFileOnClasspathLoader

Property value loading is based on a 'first win' strategy, so the first loader to find a value for a property sets the value.

Typical Use Case

Since this loader uses fixed values in code, it is only useful for specifying configuration of your application during testing. Configuration values can be directly set in code so that your application can be tested in a specific configured state. Since this is the first loader, a property value set by this load will override configuration values found by any other loader.

Basic Behaviors

• Pre-trims String values: No (Individual Properties may still trim values)
• Complains about unrecognized properties: NA - This is not possible
• Default behavior: None - This loader is only active if values are directly set as shown below

Loader Details and Configuration

One simple way to set fixed values is shown below. AndHow will discover this class implementing the AndHowInit interface during initialization to read your configuration. That looks like this:

 import org.yarnandtail.andhow.*;
 import org.yarnandtail.andhow.property.StrProp;
 
 public class SetFixedValues implements AndHowInit {
 
  @Override public AndHowConfiguration getConfiguration() {
   return  StdConfig.instance()
     .addFixedValue(MY_PROP, "some value");  //MY_PROP is some visible property
   }
 }
 

Alternatively you can use AndHow.findConfig() at an application entry point such as the main method.

This is a Standard Loader

Like all StandardLoader's, this loader is intended to be auto-created by AndHow. The set of standard loaders and their order can bet set via the AndHowConfiguration.setStandardLoaders() methods. Other loaders which don't implement the StandardLoader interface can be inserted into the load order via the AndHowConfiguration.insertLoaderBefore/After().

Author:

ericeverman

Field Summary

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

unknownPropertyAProblem, values

Constructor Summary

Constructors

Constructor and Description
StdFixedValueLoader() There is no reason to use the constructor in production application code because AndHow creates a single instance on demand at runtime.

Method Summary

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

getLoaderDialect, getLoaderType, getSpecificLoadDescription, isTrimmingRequiredForStringValues, isUnknownPropertyAProblem, load, releaseResources, setPropertyValues, setPropertyValues, 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, getLoaderType, getSpecificLoadDescription, isTrimmingRequiredForStringValues, load, releaseResources

Constructor Detail

StdFixedValueLoader

public StdFixedValueLoader()

There is no reason to use the constructor in production application code because AndHow creates a single instance on demand at runtime.