org.yarnandtail.andhow

Interface AndHowInit

All Known Subinterfaces:

AndHowTestInit

public interface AndHowInit

Marks a class as an auto-discoverable configuration provider for AndHow in production. A single implementation of AndHowInit on the classpath, if it exists, will be auto-discovered and used to initiate AndHow at startup. Usage of this interfact is optional and not normally required. Times where your application would need to implement this interface are:

• When you need to change the order precedence of the loaders such as having JNDI properties take precedence over environment variables vs System Properties. The default order of precedence is documented in each loader, see StdEnvVarLoader.
• When you want to add a loader, such as a PropFileOnFilesystemLoader
• Or to customize the default property file name used by the StdPropFileOnClasspathLoader

All of those things can be done at the entry point of your application (ie in the main method), but using an implementation of this interface ensures that the configuration is found regardless of the entry point.

It is a fatal RuntimeException for there to be more than one AndHowInit on the classpath since this would make startup configuration ambiguous. In general, never distribute a AndHowInit implementation in a reusable library since this would prevent a user of that library from creating their own AndHowInit for startup configuration of an application.

A single AndHowTestInit implementation is also allowed. See AndHowTestInit.

Method Summary

Modifier and Type	Method and Description
AndHowConfiguration	getConfiguration()

Method Detail

getConfiguration

AndHowConfiguration getConfiguration()