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, _fixedKeyObjectPairVals, _fixedVals, _missingClasspathPropFileAProblem, _missingFilesystemPropFileAProblem, classpathPropFilePathProp, classpathPropFilePathStr, DEFAULT_LOADER_LIST, envProperties, filesystemPropFilePathProp, insertAfter, insertBefore, naming, overrideGroups, 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	addFixedValue(String propertyNameOrAlias, Object value) Sets a fixed, non-configurable value for a named Property.
S	classpathPropertiesNotRequired() Sets the properties file on the classpath to be optional, the default.
S	classpathPropertiesRequired() If called to set this to 'required', a classpath properties file must exist and be readable.
S	filesystemPropFileNotRequired() Sets the properties file on the filesystem to be optional, the default.
S	filesystemPropFileRequired() If called to set this to 'required', a non-null configured value for the filesystem properties file must point to an existing, readable properties file.
S	insertLoaderAfter(Class<? extends StandardLoader> insertAfterThisLoader, Loader loaderToInsert)
S	insertLoaderBefore(Class<? extends StandardLoader> insertBeforeThisLoader, Loader loaderToInsert)
S	removeFixedValue(Property<?> property) Removes a Property value set only via addFixedValue(Property, T value) from the list of fixed values.
S	removeFixedValue(String propertyNameOrAlias) Removes a Property value set only via addFixedValue(String name, Object value) from the list of fixed values.
S	setClasspathPropFilePath(String classpathPropFilePathString) Sets the classpath path to a properties file for the StdPropFileOnClasspathLoader to read and load from.
S	setClasspathPropFilePath(StrProp classpathPropFilePathProperty) Sets the classpath path via a StrProp (a Property of String type) to a properties file for the StdPropFileOnClasspathLoader to read and load from.
S	setCmdLineArgs(String[] commandLineArgs) Sets the command line arguments, removing any previously set commandline args.
S	setEnvironmentProperties(Map<String,String> newEnvProperties) Deprecated. This method will be removed in a future release - it has no meaningful usage. Use the addFixedValue() methods instead.
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) Deprecated.

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. Values specified by the two addFixedValue methods will through a DuplicatePropertyLoaderProblem if they refer to the same Property.

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 Property value set only via addFixedValue(Property, T value) from the list of fixed values. It is not an error to attempt to remove a property that is not in this fixed value list.

Parameters:

property - A non-null property.

Returns:

addFixedValue

public S addFixedValue(String propertyNameOrAlias,
                       Object value)

Description copied from interface: AndHowConfiguration

Sets a fixed, non-configurable value for a named 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. Values specified by the two addFixedValue methods will through a DuplicatePropertyLoaderProblem if they refer to the same Property.

Parameters:

propertyNameOrAlias - The canonical or alias name of Property, which is trimmed to null.

value - The Object value to set, which must match the type of the Property.

Returns:

removeFixedValue

public S removeFixedValue(String propertyNameOrAlias)

Description copied from interface: AndHowConfiguration

Removes a Property value set only via addFixedValue(String name, Object value) from the list of fixed values. Note that to successfully remove a fixed value from this list, the name must exactly match the name used to set the property via addFixedValue(String, Object). Since Properties can have aliases, you must know the exact name to set the property. It is not an error to attempt to remove a property that is not in this fixed value list, or to attempt to remove a property value that does not exist - these are just no-ops.

Parameters:

propertyNameOrAlias - The name or alias of a property.

Returns:

setCmdLineArgs

public S setCmdLineArgs(String[] commandLineArgs)

Description copied from interface: AndHowConfiguration

Sets the command line arguments, removing any previously set commandline args. Setting empty or null results in removing all previously set command line arguments

Returns:

setClasspathPropFilePath

public S setClasspathPropFilePath(String classpathPropFilePathString)

Description copied from interface: AndHowConfiguration

Sets the classpath path to a properties file for the StdPropFileOnClasspathLoader to read and load from. If no path is specified via one of the two setClasspathPropFilePath methods, the default classpath of '/andhow.properties' is used.

As per Java convention, a path on the classpath can use dots or slashes to separate packages. However, if the file name itself contains dots, then the path must start with a slash and use slashes to separate packages.

Valid Examples:

• /andhow.property - The default. The file is at the root and the name contains a dot
• /org/ngo/config.props - Similar to above, but in the org.ngo package, the file name is 'config.props'
• org.ngo.props - The package is org.ngo, the file name is 'props'. There are no dots in the file name, so its OK to use dots to separate the packages

Returns:

setClasspathPropFilePath

public S setClasspathPropFilePath(StrProp classpathPropFilePathProperty)

Description copied from interface: AndHowConfiguration

Sets the classpath path via a StrProp (a Property of String type) to a properties file for the StdPropFileOnClasspathLoader to read and load from. If no path is specified via one of the two setClasspathPropFilePath methods, the default classpath of '/andhow.properties' is used.

As per Java convention, a path on the classpath can use dots or slashes to separate packages. However, if the file name itself contains dots, then the path must start with a slash and use slashes to separate packages. Its common to have a '.properties' extension on the properties file, so its good practice to add a validation rule to the StrProp used here to ensure it mustStartWith("/").

Valid Examples of configured values:

• /andhow.property - The default. The file is at the root and the name contains a dot
• /org/ngo/config.props - Similar to above, but in the org.ngo package, the file name is 'config.props'
• org.ngo.props - The package is org.ngo, the file name is 'props'. There are no dots in the file name, so its OK to use dots to separate the packages

Returns:

classpathPropertiesRequired

public S classpathPropertiesRequired()

Description copied from interface: AndHowConfiguration

If called to set this to 'required', a classpath properties file must exist and be readable. This flag is used by the StdPropFileOnClasspathLoader. Since the StdPropFileOnClasspathLoader has a default property file name, /andhow.properties, setting this to 'required' means that either that default file name or another that you configure instead must exist.

Returns:

See Also:

methods for details on using a non-default classpath properties file. A RuntimeException will be thrown if this is set to 'required' and there is no classpath properties file that can be read.
This is NOT set by default, allowing the properties file to be optional.

classpathPropertiesNotRequired

public S classpathPropertiesNotRequired()

Description copied from interface: AndHowConfiguration

Sets the properties file on the classpath to be optional, the default.

Returns:

See Also:

AndHowConfiguration.classpathPropertiesRequired()

setFilesystemPropFilePath

public S setFilesystemPropFilePath(StrProp filesystemPropFilePath)

Description copied from interface: AndHowConfiguration

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.

Returns:

filesystemPropFileRequired

public S filesystemPropFileRequired()

Description copied from interface: AndHowConfiguration

If called to set this to 'required', a non-null configured value for the filesystem properties file must point to an existing, readable properties file. This flag is used by the StdPropFileOnFilesystemLoader. A RuntimeException will be thrown if this is set to 'required' and there is a path specified which points to a file that does not exist. Configuring a filesystem path is a two step process:

• First, a StrProp Property must be specified for this configuration via the setFilesystemPropFilePath method
• Then, a value must be configured for in an any way that AndHow reads and loads values, such as environment vars, system properties, etc..

If and non-null value is configured, its doesn't point to a readable properties file, AND this required flag is set, a RuntimeException will be thrown at startup.
This is NOT set by default, allowing the properties file to be optional.

Returns:

filesystemPropFileNotRequired

public S filesystemPropFileNotRequired()

Description copied from interface: AndHowConfiguration

Sets the properties file on the filesystem to be optional, the default.

Returns:

See Also:

AndHowConfiguration.setFilesystemPropFilePath(org.yarnandtail.andhow.property.StrProp)

setSystemProperties

@Deprecated
public S setSystemProperties(Properties properties)

Deprecated.

Allows system properties to be overridden.

Parameters:

properties -

setEnvironmentProperties

@Deprecated
public S setEnvironmentProperties(Map<String,String> newEnvProperties)

Deprecated. This method will be removed in a future release - it has no meaningful usage. Use the addFixedValue() methods instead.

Sets the System environment vars that AndHow will use to load Property values from for the StdEnvVarLoader loader. If this method is not called or is called with a null Map, the actual env vars from System.getenv() will be used. Calling this method with an empty Map will effectively prevent AndHow from receiving configuration from env vars. This does not actually change actual environment variables or what is returned from System.getenv(). It only replaces what AndHow will see for env vars. Note: There is no reason to use this method: Use one of the addFixedValue() methods instead. Those methods are more clear, don't have to parse values, and (unlike this method) are not deprecated.

Parameters:

newEnvProperties -

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)