LoaderEnvironmentBuilder (AndHow Annotation Processor 1.5.0 API)

java.lang.Object
- org.yarnandtail.andhow.load.util.LoaderEnvironmentBuilder

All Implemented Interfaces:

LoaderEnvironment
```
public class LoaderEnvironmentBuilder
extends Object
implements LoaderEnvironment
```
A mutable builder implementation of LoaderEnvironment.

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<String>`	`_cmdLineArgs`
`protected Map<String,String>`	`_envVars`
`protected Map<String,Object>`	`_fixedNamedValues`
`protected List<PropertyValue<?>>`	`_fixedPropertyValues`
`protected Supplier<JndiContextWrapper>`	`_jndiContextSupplier`
`protected boolean`	`_replaceEnvVars`
`protected boolean`	`_replaceSysProps`
`protected Map<String,String>`	`_sysProps`

Constructor Summary

Constructors
Constructor and Description

LoaderEnvironmentBuilder()

Constructors
Constructor and Description
`LoaderEnvironmentBuilder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> void`	`addFixedValue(Property<T> property, T value)` Sets a fixed, non-configurable value for a Property.
`void`	`addFixedValue(String propertyNameOrAlias, Object value)` Sets a fixed, non-configurable value for a named Property.
`protected static Map<String,String>`	`buildPropertyMap(Properties props)`
`List<String>`	`getCmdLineArgs()` Returns the command line argument strings passed to the `main(String[] args)` method, as a List, if they are available.
`Map<String,String>`	`getEnvVars()` Returns the Map of overridden environment variables, if any.
`Map<String,Object>`	`getFixedNamedValues()` Returns a Map of hard-coded / fixed values for some properties referenced by name and set by application code prior to AndHow initialization.
`List<PropertyValue<?>>`	`getFixedPropertyValues()` Returns a List of hard-coded / fixed values for some properties in the form of a List of `PropertyValue`s, set application code prior to AndHow initialization.
`JndiContextWrapper`	`getJndiContext()` Returns a JNDI Context that can be used by loaders to load from JNDI.
`Supplier<JndiContextWrapper>`	`getJndiContextSupplier()`
`Map<String,String>`	`getSysProps()` Returns the Map of overridden system properties, if any.
`boolean`	`isEnvVarsReplaced()` Returns true if the normal `System.getenv()` values are being replaced by the contents of `getEnvVars()`.
`boolean`	`isSysPropsReplaced()` Returns true if the normal `System.getProperties()` values are being replaced by the contents of `getSysProps()`.
`Object`	`removeFixedValue(Property<?> property)` Removes a fixed Property value set only via addFixedValue(Property, T value) or `setFixedPropertyValues(List)`.
`Object`	`removeFixedValue(String propertyNameOrAlias)` Removes a Property value set only via addFixedValue(String name, Object value) or `setFixedNamedValues(Map)`.
`void`	`resetToActualEnvVars()` Forces any previous env.
`void`	`resetToActualSysProps()` Forces any previous sys.
`void`	`setCmdLineArgs(String[] commandLineArgs)` Set the commandline arguments, overriding any previously set values.
`void`	`setEnvVars(Map<String,String> envVars)` Set the environment vars that the Loaders see, overriding the actual env.
`void`	`setFixedNamedValues(Map<String,Object> fixedVals)` Set the fixed / hardcoded named property values, overriding any previously set values.
`void`	`setFixedPropertyValues(List<PropertyValue<?>> fixedVals)` Set the fixed / hardcoded property values, overriding any previously set values.
`void`	`setJndiContextSupplier(Supplier<JndiContextWrapper> jndiContextSupplier)`
`void`	`setSysProps(Map<String,String> sysProps)` Set the java system properties that the Loaders see, overriding the actual sys.
`LoaderEnvironmentImm`	`toImmutable()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _envVars
```
protected final Map<String,String> _envVars
```
  - _sysProps
```
protected final Map<String,String> _sysProps
```
  - _cmdLineArgs
```
protected final List<String> _cmdLineArgs
```
  - _fixedNamedValues
```
protected final Map<String,Object> _fixedNamedValues
```
  - _fixedPropertyValues
```
protected final List<PropertyValue<?>> _fixedPropertyValues
```
  - _replaceEnvVars
```
protected boolean _replaceEnvVars
```
  - _replaceSysProps
```
protected boolean _replaceSysProps
```
  - _jndiContextSupplier
```
protected Supplier<JndiContextWrapper> _jndiContextSupplier
```
- Constructor Detail
  - LoaderEnvironmentBuilder
```
public LoaderEnvironmentBuilder()
```
- Method Detail
  - setEnvVars
```
public void setEnvVars(Map<String,String> envVars)
```
    Set the environment vars that the Loaders see, overriding the actual env. vars.
    Calling this method causes the passed Map to completely replace the values that Loaders would have seen coming from the OS provided environment variables. Passing a null or empty Map results in the loaders seeing no env vars. Values are overwritten each time this method is called.
    
    Parameters:
    
    envVars - The new env vars to use. Null and empty both result in the zero env vars.
  - resetToActualEnvVars
```
public void resetToActualEnvVars()
```
    Forces any previous env. vars. set via setEnvVars(Map) to be dumped and the actual OS provided env. vars. will be used instead.
    Note that calling getEnvVars() will return an empty collection after this method is called. The real env. vars. will be injected when toImmutable() is called.
  - isEnvVarsReplaced
```
public boolean isEnvVarsReplaced()
```
    Returns true if the normal System.getenv() values are being replaced by the contents of getEnvVars(). This is set to true by calling setEnvVars(Map), false by calling resetToActualEnvVars().
    
    Returns:
    
    True if replacement will happen.
  - setSysProps
```
public void setSysProps(Map<String,String> sysProps)
```
    Set the java system properties that the Loaders see, overriding the actual sys. props.
    Calling this method causes the passed Map to completely replace the values that Loaders would have seen coming from System.getProperties(). Passing a null or empty Map results in the loaders seeing no sys. props. Values are overwritten each time this method is called.
    
    Parameters:
    
    sysProps - The new sys props to use. Null and empty both result in the zero sys. props.
  - resetToActualSysProps
```
public void resetToActualSysProps()
```
    Forces any previous sys. props. set via setSysProps(Map)} to be dumped and the actual System.getProperties() will be used instead.
    Note that calling getSysProps() will return an empty collection after this method is called. The real sys. props. will be injected when toImmutable() is called.
  - isSysPropsReplaced
```
public boolean isSysPropsReplaced()
```
    Returns true if the normal System.getProperties() values are being replaced by the contents of getSysProps(). This is set to true by calling setSysProps(Map), false by calling resetToActualSysProps().
    
    Returns:
    
    True if replacement will happen.
  - setCmdLineArgs
```
public void setCmdLineArgs(String[] commandLineArgs)
```
    Set the commandline arguments, overriding any previously set values.
    
    Parameters:
    
    commandLineArgs - The new cmd line args to use
  - setFixedNamedValues
```
public void setFixedNamedValues(Map<String,Object> fixedVals)
```
    Set the fixed / hardcoded named property values, overriding any previously set values.
    FixedNamedValues and FixedPropertyValues are handled separately, but accomplish the same thing. Both result in setting the value of the reference Property to a value in code. setFixedNamedValues will only affect named values (it does not overwrite FixedPropertyValues). See LoaderEnvironment.getFixedNamedValues().
    
    Parameters:
    
    fixedVals - A map of fixed values, using either canonical or alias names for keys and correctly typed objects or Strings that can be parsed to the correct type for the referenced Property. If null or empty, the resulting fixedNamedValue map will be empty.
  - addFixedValue
```
public <T> void addFixedValue(Property<T> property,
                              T value)
```
    Sets a fixed, non-configurable value for a Property.
    
    Type Parameters:
    
    T - The type of Property and value
    
    Parameters:
    
    property - The property to set a value for
    
    value - The value to set.
  - removeFixedValue
```
public Object removeFixedValue(Property<?> property)
```
    Removes a fixed Property value set only via addFixedValue(Property, T value) or setFixedPropertyValues(List). 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:
    
    The fixed value previously associated with this Property or null if there was none.
  - addFixedValue
```
public void addFixedValue(String propertyNameOrAlias,
                          Object value)
```
    Sets a fixed, non-configurable value for a named 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.
    
    Throws:
    
    IllegalArgumentException - if the name trims to null, the value is null, or the name is already associated w/ a value (use remove).
  - removeFixedValue
```
public Object removeFixedValue(String propertyNameOrAlias)
```
    Removes a Property value set only via addFixedValue(String name, Object value) or setFixedNamedValues(Map). 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:
    
    The value previously associated w/ the name.
  - getJndiContextSupplier
```
public Supplier<JndiContextWrapper> getJndiContextSupplier()
```
  - setJndiContextSupplier
```
public void setJndiContextSupplier(Supplier<JndiContextWrapper> jndiContextSupplier)
```
  - setFixedPropertyValues
```
public void setFixedPropertyValues(List<PropertyValue<?>> fixedVals)
```
    Set the fixed / hardcoded property values, overriding any previously set values.
    FixedNamedValues and FixedPropertyValues are handled separately, but accomplish the same thing. Both result in setting the value of the reference Property to a value in code. setFixedPropertyValues will only affect PropertyValues (it does not overwrite FixedNamedValues). See LoaderEnvironment.getFixedPropertyValues().
    
    Parameters:
    
    fixedVals - A list of fixed PropertyValue's. If null or empty, the resulting fixedPropertyValue list will be empty.
  - toImmutable
```
public LoaderEnvironmentImm toImmutable()
```
  - buildPropertyMap
```
protected static Map<String,String> buildPropertyMap(Properties props)
```
  - getEnvVars
```
public Map<String,String> getEnvVars()
```
    Returns the Map of overridden environment variables, if any.
    If isEnvVarsReplaced() is true, then the values returned here will be used as the env vars when loading configuration values. If false, the actual System.getenv() will be used. See setEnvVars(Map) and resetToActualEnvVars() for setting and unsetting these values.
    
    Specified by:
    
    getEnvVars in interface LoaderEnvironment
    
    Returns:
    
    A map of variable names to values. Never null, but possibly empty.
  - getSysProps
```
public Map<String,String> getSysProps()
```
    Returns the Map of overridden system properties, if any.
    If isSysPropsReplaced() is true, then the values returned here will be used as the system properties when loading configuration values. If false, the actual System.getProperties() will be used. See setSysProps(Map) and resetToActualSysProps() for setting and unsetting these values.
    
    Specified by:
    
    getSysProps in interface LoaderEnvironment
    
    Returns:
    
    A map of variable names to values. Never null, but possibly empty.
  - getCmdLineArgs
```
public List<String> getCmdLineArgs()
```
    Description copied from interface: LoaderEnvironment
    
    Returns the command line argument strings passed to the main(String[] args) method, as a List, if they are available.
    Its possible that cmd line arguments are passed to the application but not available here. This is because AndHow has no way to intercept cmd line arguments, so application code needs to pass them in to AndHow, which may not have been done (See how-to details in StdMainStringArgsLoader).
    Nominally this returns the same as the cmd line arguments converted to a List, but may be customized for testing.
    
    Specified by:
    
    getCmdLineArgs in interface LoaderEnvironment
    
    Returns:
    
    A list of the command line arguments if available, or an empty List. Never null.
  - getFixedNamedValues
```
public Map<String,Object> getFixedNamedValues()
```
    Description copied from interface: LoaderEnvironment
    
    Returns a Map of hard-coded / fixed values for some properties referenced by name and set by application code prior to AndHow initialization.
    The referenced Properties and values returned by this method and LoaderEnvironment.getFixedPropertyValues() are intended to be loaded by the StdFixedValueLoader, which nominally loads prior to any other loader, effectively making the value non-configurable.
    
    Specified by:
    
    getFixedNamedValues in interface LoaderEnvironment
    
    Returns:
    
    A map of property names (canonical or aliases) to property values, which may be Strings or the destination type of the named Property. Never null, but possibly empty.
  - getFixedPropertyValues
```
public List<PropertyValue<?>> getFixedPropertyValues()
```
    Description copied from interface: LoaderEnvironment
    
    Returns a List of hard-coded / fixed values for some properties in the form of a List of PropertyValues, set application code prior to AndHow initialization.
    The referenced Properties and values returned by this method and LoaderEnvironment.getFixedNamedValues() are intended to be loaded by the StdFixedValueLoader, which nominally loads prior to any other loader, effectively making the value non-configurable.
    
    Specified by:
    
    getFixedPropertyValues in interface LoaderEnvironment
    
    Returns:
    
    A list of PropertyValue's. Never null, but possibly empty.
  - getJndiContext
```
public JndiContextWrapper getJndiContext()
```
    Description copied from interface: LoaderEnvironment
    
    Returns a JNDI Context that can be used by loaders to load from JNDI.
    
    Specified by:
    
    getJndiContext in interface LoaderEnvironment
    
    Returns:
    
    A JNDI Context wrapper, which may contain a Jndi context or a null Jndi context and an exception.

Class LoaderEnvironmentBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_envVars

_sysProps

_cmdLineArgs

_fixedNamedValues

_fixedPropertyValues

_replaceEnvVars

_replaceSysProps

_jndiContextSupplier

Constructor Detail

LoaderEnvironmentBuilder

Method Detail

setEnvVars

resetToActualEnvVars

isEnvVarsReplaced

setSysProps

resetToActualSysProps

isSysPropsReplaced

setCmdLineArgs

setFixedNamedValues

addFixedValue

removeFixedValue

addFixedValue

removeFixedValue

getJndiContextSupplier

setJndiContextSupplier

setFixedPropertyValues

toImmutable

buildPropertyMap

getEnvVars

getSysProps

getCmdLineArgs

getFixedNamedValues

getFixedPropertyValues

getJndiContext