LoaderEnvironment (AndHow Annotation Processor 1.5.0 API)

All Known Implementing Classes:

LoaderEnvironmentBuilder, LoaderEnvironmentImm
```
public interface LoaderEnvironment
```
The runtime environment seen by Loaders when they load values.
Some of the places Loaders load values from are one-of-a-kind / unique resources, such as system properties, environment variables, command line arguments, etc.. Rather than inject each loader with it's needed resources, the LoaderEnvironment makes them available to all loaders. This interface also simplifies testing by providing a central place to set the environment Loaders will see.
Note that there are two, parallel 'fixedValue' systems: name and Property. These are two equally valid ways to set a fixed value, but they cannot be reconciled until the AndHow initialization is complete to resolve names.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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 a string map view of the current system environment variables.
`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.
`Map<String,String>`	`getSysProps()` Returns a snapshot of current system properties.

- Method Detail
  - getEnvVars
```
Map<String,String> getEnvVars()
```
    Returns a string map view of the current system environment variables.
    Nominally the same as System.getenv(), but may be customized for testing.
    
    Returns:
    
    The environment as a map of variable names to values. Never null, but possibly empty.
  - getSysProps
```
Map<String,String> getSysProps()
```
    Returns a snapshot of current system properties.
    Nominally the same as System.getProperties(), but may be customized for testing.
    
    Returns:
    
    A snapshot of the system properties, as a Map. Never null, but possibly empty.
  - getCmdLineArgs
```
List<String> getCmdLineArgs()
```
    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.
    
    Returns:
    
    A list of the command line arguments if available, or an empty List. Never null.
  - getFixedNamedValues
```
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.
    The referenced Properties and values returned by this method and getFixedPropertyValues() are intended to be loaded by the StdFixedValueLoader, which nominally loads prior to any other loader, effectively making the value non-configurable.
    
    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
```
List<PropertyValue<?>> getFixedPropertyValues()
```
    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 getFixedNamedValues() are intended to be loaded by the StdFixedValueLoader, which nominally loads prior to any other loader, effectively making the value non-configurable.
    
    Returns:
    
    A list of PropertyValue's. Never null, but possibly empty.
  - getJndiContext
```
JndiContextWrapper getJndiContext()
```
    Returns a JNDI Context that can be used by loaders to load from JNDI.
    
    Returns:
    
    A JNDI Context wrapper, which may contain a Jndi context or a null Jndi context and an exception.

Interface LoaderEnvironment

Method Summary

Method Detail

getEnvVars

getSysProps

getCmdLineArgs

getFixedNamedValues

getFixedPropertyValues

getJndiContext