org.yarnandtail.andhow

Class StdConfig.StdConfigAbstract<S extends StdConfig.StdConfigAbstract<S>>

java.lang.Object

org.yarnandtail.andhow.BaseConfig<S>

org.yarnandtail.andhow.StdConfig.StdConfigAbstract<S>

Type Parameters:

S -

All Implemented Interfaces:

AndHowConfiguration<S>

Direct Known Subclasses:

StdConfig.StdConfigImpl

Enclosing class:

StdConfig

public abstract static class StdConfig.StdConfigAbstract<S extends StdConfig.StdConfigAbstract<S>>
extends BaseConfig<S>

Abstract class here lets this be extended maintaining the generic types

Field Summary

Fields inherited from class org.yarnandtail.andhow.BaseConfig

_cmdLineArgs, _fixedVals, _missingClasspathPropFileAProblem, _missingFilesystemPropFileAProblem, classpathPropFilePathProp, classpathPropFilePathStr, DEFAULT_LOADER_LIST, envProperties, filesystemPropFilePathProp, insertAfter, insertBefore, naming, standardLoaders, systemProperties

Constructor Summary

Constructors

Constructor and Description
StdConfigAbstract()

Method Summary

Modifier and Type	Method and Description
<T> S	addFixedValue(Property<T> property, T value) Sets a fixed, non-configurable value for a Property.
S	classpathPropertiesNotRequired() If set, the properties file loaded by StdPropFileOnClasspathLoader is optional and will not throw an error if it is not found.
S	classpathPropertiesRequired() If set, the properties file loaded by StdPropFileOnClasspathLoader must be found and a RuntimeException will be thrown if it is not found.
S	filesystemPropFileNotRequired() If set, the properties file loaded by StdPropFileOnFilesystemLoader is optional and will not throw an error if it is not found.
S	filesystemPropFileRequired() If set, the properties file loaded by StdPropFileOnFilesystemLoader must be found and a RuntimeException will be thrown if it is not found.
S	insertLoaderAfter(Class<? extends StandardLoader> insertAfterThisLoader, Loader loaderToInsert)
S	insertLoaderBefore(Class<? extends StandardLoader> insertBeforeThisLoader, Loader loaderToInsert)
S	removeFixedValue(Property<?> property) Removes a PropertyValue from the list of fixed values.
S	setClasspathPropFilePath(String classpathPropFilePathString) Sets the classpath path to a properties file for the StdPropFileOnClasspathLoader to load.
S	setClasspathPropFilePath(StrProp classpathPropFilePathProperty) Sets the classpath path via a StrProp (a Property of String type) to a properties file for the StdPropFileOnClasspathLoader to load.
S	setCmdLineArgs(String[] commandLineArgs) Sets the command line arguments, removing any previously set commandline args.
S	setEnvironmentProperties(Map<String,String> envProperties) Allows the System environment to be overridden.
S	setFilesystemPropFilePath(StrProp filesystemPropFilePath) Sets the filesystem path via a StrProp (a Property of String type) to a properties file for the StdPropFileOnFilesystemLoader to load.
S	setStandardLoaders(Class<? extends StandardLoader>... newStandardLoaders)
S	setStandardLoaders(List<Class<? extends StandardLoader>> newStandardLoaders)
S	setSystemProperties(Properties properties) Allows system properties to be overridden.

Methods inherited from class org.yarnandtail.andhow.BaseConfig

build, buildLoaders, buildStdEnvVarLoader, buildStdFixedValueLoader, buildStdJndiLoader, buildStdMainStringArgsLoader, buildStdPropFileOnClasspathLoader, buildStdPropFileOnFilesystemLoader, buildStdSysPropLoader, getDefaultLoaderList, getNamingStrategy, getRegisteredGroups

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StdConfigAbstract

public StdConfigAbstract()

Method Detail

addFixedValue

public <T> S addFixedValue(Property<T> property,
                           T value)

Description copied from interface: AndHowConfiguration

Sets a fixed, non-configurable value for a Property. Property values set in this way use the FixedValueLoader to load values prior to any other loader. Since the first loaded value for a Property 'wins', this effectively fixes the value and makes it non-configurable.

Type Parameters:

T - The type of Property and value

Parameters:

property - The property to set a value for

value - The value to set.

Returns:

removeFixedValue

public S removeFixedValue(Property<?> property)

Description copied from interface: AndHowConfiguration

Removes a PropertyValue from the list of fixed values. It is not an error to attempt to remove a property that is not in the current fixed value list.

Parameters:

property - A non-null property.

Returns:

setCmdLineArgs

public S setCmdLineArgs(String[] commandLineArgs)

Description copied from interface: AndHowConfiguration

Sets the command line arguments, removing any previously set commandline args.

Returns:

setClasspathPropFilePath

public S setClasspathPropFilePath(String classpathPropFilePathString)

Sets the classpath path to a properties file for the StdPropFileOnClasspathLoader to load. If no path is specified via either a String or StrProp, the path '/andhow.properties' is used.
Paths should start with a forward slash and have packages delimited by forward slashes. If the file name contains a dot, the path must start with a forward slash.

Parameters:

classpathPropFilePathString -

Returns:

setClasspathPropFilePath

public S setClasspathPropFilePath(StrProp classpathPropFilePathProperty)

Sets the classpath path via a StrProp (a Property of String type) to a properties file for the StdPropFileOnClasspathLoader to load. If no path is specified via either a String or StrProp, the path '/andhow.properties' is used.
Paths should start with a forward slash and have packages delimited by forward slashes. If the file name contains a dot, the path must start with a forward slash. Thus, it is good practice to add a validation rule to the StrProp used here to ensure it mustStartWith("/").

Parameters:

classpathPropFilePathProperty -

Returns:

classpathPropertiesRequired

public S classpathPropertiesRequired()

If set, the properties file loaded by StdPropFileOnClasspathLoader must be found and a RuntimeException will be thrown if it is not found. This is not set by default, allowing the properties file to be optional.

Returns:

classpathPropertiesNotRequired

public S classpathPropertiesNotRequired()

If set, the properties file loaded by StdPropFileOnClasspathLoader is optional and will not throw an error if it is not found. This is set by default, so there is no need to explicitly call it.

Returns:

setFilesystemPropFilePath

public S setFilesystemPropFilePath(StrProp filesystemPropFilePath)

Sets the filesystem path via a StrProp (a Property of String type) to a properties file for the StdPropFileOnFilesystemLoader to load. If no property is set to specify a path, or a property is set by has no value, this loader won't be used. If the property is specified but the specified file is missing, an error will be thrown based on the filesystemPropFileRequired flag. Paths should generally be absolute and correctly formed for the host environment.

Parameters:

filesystemPropFilePath -

Returns:

filesystemPropFileRequired

public S filesystemPropFileRequired()

If set, the properties file loaded by StdPropFileOnFilesystemLoader must be found and a RuntimeException will be thrown if it is not found. This is not set by default, allowing the properties file to be optional.

Returns:

filesystemPropFileNotRequired

public S filesystemPropFileNotRequired()

If set, the properties file loaded by StdPropFileOnFilesystemLoader is optional and will not throw an error if it is not found. This is set by default, so there is no need to explicitly call it.

Returns:

setSystemProperties

public S setSystemProperties(Properties properties)

Allows system properties to be overridden.

Parameters:

properties -

setEnvironmentProperties

public S setEnvironmentProperties(Map<String,String> envProperties)

Allows the System environment to be overridden.

Parameters:

envProperties -

Returns:

setStandardLoaders

public S setStandardLoaders(List<Class<? extends StandardLoader>> newStandardLoaders)

setStandardLoaders

public S setStandardLoaders(Class<? extends StandardLoader>... newStandardLoaders)

insertLoaderBefore

public S insertLoaderBefore(Class<? extends StandardLoader> insertBeforeThisLoader,
                            Loader loaderToInsert)

insertLoaderAfter

public S insertLoaderAfter(Class<? extends StandardLoader> insertAfterThisLoader,
                           Loader loaderToInsert)