org.yarnandtail.andhow.Options Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of andhow-core Show documentation

Simple typed and validated configuration loading for web apps, command line or any environment application.

There is a newer version: 1.5.0

package org.yarnandtail.andhow;

import org.yarnandtail.andhow.property.FlagProp;
import org.yarnandtail.andhow.property.StrProp;

/**
 * Global options to configure AndHow behavior.
 *
 * This BasePropertyGroup is always implicitly added to the list of registered
 * groups. Configuration instances should not directly add it because it will
 * result in a duplicate BasePropertyGroup configuration error.
 *
 * Convention: All options will have aliases. To make naming collisions less
 * likely, all aliases will start with 'AH'.
 *
 * Implementation Note: All Properties here must be optional or have a default
 * value since the framework itself should have no requirements to operate.
 *
 * @author ericeverman
 */
@GroupInfo(name = "AndHow! Configuration Framework Configuration", desc = "Configures how AndHow itself operates")
public interface Options {

	FlagProp CREATE_SAMPLES = FlagProp.builder().aliasIn("AHForceCreateSamples")
			.desc("Forces configuration samples to be sent to the console for each loader that supports it.")
			.helpText("On cmdline, this works as a flag and is assumed 'true' just by being present. In other config sources it can be set to 'true'.")
			.build();
	StrProp SAMPLES_DIRECTORY = StrProp.builder().defaultValue("java.io.tmpdir/andhow-samples/").mustBeNonNull().mustEndWith("/")
			.desc("Path to a directory to be used to write sample configuration to. "
					+ "The special 'java.io.tmpdir' string is recognized as the current Java temp directory.")
			.helpText("All paths should be specified w/ forward slashes, even on windows systems.")
			.build();
}