BaseConfig (AndHow Annotation Processor 1.5.0 API)

java.lang.Object
- org.yarnandtail.andhow.BaseConfig<C>

Type Parameters:

C - The class to return from each of the fluent builder methods, which will be the implementation class in each case. See StdConfig for an example.

All Implemented Interfaces:

AndHowConfiguration<C>

Direct Known Subclasses:

StdConfig.StdConfigAbstract
```
public abstract class BaseConfig<C extends BaseConfig<C>>
extends Object
implements AndHowConfiguration<C>
```
Basic abstract implementation for AndHowConfiguration instances.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`_missingClasspathPropFileAProblem`
`protected boolean`	`_missingFilesystemPropFileAProblem`
`protected StrProp`	`classpathPropFilePathProp`
`protected String`	`classpathPropFilePathStr`
`protected static Class<?>[]`	`DEFAULT_LOADER_LIST`
`protected StrProp`	`filesystemPropFilePathProp`
`protected Map<Class<? extends StandardLoader>,List<Loader>>`	`insertAfter`
`protected Map<Class<? extends StandardLoader>,List<Loader>>`	`insertBefore`
`protected LoaderEnvironmentBuilder`	`loadEnvBuilder`
`protected NamingStrategy`	`naming`
`protected List<Class<?>>`	`overrideGroups` If non-null, overrides the default group discovery process with this override list.
`protected List<Class<? extends StandardLoader>>`	`standardLoaders`

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseConfig()
Construct a new instance.

Constructors
Modifier	Constructor and Description
`protected`	`BaseConfig()` Construct a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Loader>`	`buildLoaders()`
`protected StdEnvVarLoader`	`buildStdEnvVarLoader()` Build a StdEnvVarLoader, passing it the needed context.
`protected StdFixedValueLoader`	`buildStdFixedValueLoader()` Build a StdFixedValueLoader, passing it the needed context.
`protected StdJndiLoader`	`buildStdJndiLoader()` Build a StdJndiLoader, passing it the needed context.
`protected StdMainStringArgsLoader`	`buildStdMainStringArgsLoader()` Build a StdMainStringArgsLoader, passing it the needed context.
`protected StdPropFileOnClasspathLoader`	`buildStdPropFileOnClasspathLoader()` Build a StdPropFileOnClasspathLoader, passing it the needed context.
`protected StdPropFileOnFilesystemLoader`	`buildStdPropFileOnFilesystemLoader()` Build a StdPropFileOnFilesystemLoader, passing it the needed context.
`protected StdSysPropLoader`	`buildStdSysPropLoader()` Build a StdSysPropLoader, passing it the needed context.
`List<Class<? extends StandardLoader>>`	`getDefaultLoaderList()` The default list of standard loaders, as a list of Classes that implement `StandardLoader`
`LoaderEnvironment`	`getLoaderEnvironment()` Returns an immutable LoaderEnvironment with all collections fully expanded.
`NamingStrategy`	`getNamingStrategy()` Return the naming strategy used to form Property names, match them to values and display them.
`List<GroupProxy>`	`getRegisteredGroups()` Return a custom list of 'Groups' (classes or interfaces containing AndHow Properties) to use instead of allowing the auto-discovery to find the Groups.

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

Methods inherited from interface org.yarnandtail.andhow.AndHowConfiguration
addFixedValue, addFixedValue, classpathPropertiesNotRequired, classpathPropertiesRequired, filesystemPropFileNotRequired, filesystemPropFileRequired, insertLoaderAfter, insertLoaderBefore, removeFixedValue, removeFixedValue, setClasspathPropFilePath, setClasspathPropFilePath, setCmdLineArgs, setFilesystemPropFilePath, setStandardLoaders, setStandardLoaders

- Field Detail
  - DEFAULT_LOADER_LIST
```
protected static final Class<?>[] DEFAULT_LOADER_LIST
```
  - standardLoaders
```
protected List<Class<? extends StandardLoader>> standardLoaders
```
  - insertBefore
```
protected Map<Class<? extends StandardLoader>,List<Loader>> insertBefore
```
  - insertAfter
```
protected Map<Class<? extends StandardLoader>,List<Loader>> insertAfter
```
  - loadEnvBuilder
```
protected LoaderEnvironmentBuilder loadEnvBuilder
```
  - classpathPropFilePathStr
```
protected String classpathPropFilePathStr
```
  - classpathPropFilePathProp
```
protected StrProp classpathPropFilePathProp
```
  - _missingClasspathPropFileAProblem
```
protected boolean _missingClasspathPropFileAProblem
```
  - filesystemPropFilePathProp
```
protected StrProp filesystemPropFilePathProp
```
  - _missingFilesystemPropFileAProblem
```
protected boolean _missingFilesystemPropFileAProblem
```
  - naming
```
protected NamingStrategy naming
```
  - overrideGroups
```
protected List<Class<?>> overrideGroups
```
    If non-null, overrides the default group discovery process with this override list. There is no set method here - subclasses may make editable for use in testing.
- Constructor Detail
  - BaseConfig
```
protected BaseConfig()
```
    Construct a new instance.
- Method Detail
  - getNamingStrategy
```
public NamingStrategy getNamingStrategy()
```
    Description copied from interface: AndHowConfiguration
    
    Return the naming strategy used to form Property names, match them to values and display them. Currently only CaseInsensitiveNaming is implemented.
    
    Specified by:
    
    getNamingStrategy in interface AndHowConfiguration<C extends BaseConfig<C>>
    
    Returns:
    
    The strategy to use. Must not be null.
  - buildStdFixedValueLoader
```
protected StdFixedValueLoader buildStdFixedValueLoader()
```
    Build a StdFixedValueLoader, passing it the needed context. This method, like the other buildStd....Loader methods is called based on the class name of a StandardLoader.
    
    Returns:
    
    A new StandardLoader, initialized with proper context for its type.
  - buildStdMainStringArgsLoader
```
protected StdMainStringArgsLoader buildStdMainStringArgsLoader()
```
    Build a StdMainStringArgsLoader, passing it the needed context. This method, like the other buildStd....Loader methods is called based on the class name of a StandardLoader.
    
    Returns:
    
    A new StandardLoader, initialized with proper context for its type.
  - buildStdSysPropLoader
```
protected StdSysPropLoader buildStdSysPropLoader()
```
    Build a StdSysPropLoader, passing it the needed context. This method, like the other buildStd....Loader methods is called based on the class name of a StandardLoader.
    
    Returns:
    
    A new StandardLoader, initialized with proper context for its type.
  - buildStdJndiLoader
```
protected StdJndiLoader buildStdJndiLoader()
```
    Build a StdJndiLoader, passing it the needed context. This method, like the other buildStd....Loader methods is called based on the class name of a StandardLoader.
    
    Returns:
    
    A new StandardLoader, initialized with proper context for its type.
  - buildStdEnvVarLoader
```
protected StdEnvVarLoader buildStdEnvVarLoader()
```
    Build a StdEnvVarLoader, passing it the needed context. This method, like the other buildStd....Loader methods is called based on the class name of a StandardLoader.
    
    Returns:
    
    A new StandardLoader, initialized with proper context for its type.
  - buildStdPropFileOnFilesystemLoader
```
protected StdPropFileOnFilesystemLoader buildStdPropFileOnFilesystemLoader()
```
    Build a StdPropFileOnFilesystemLoader, passing it the needed context. This method, like the other buildStd....Loader methods is called based on the class name of a StandardLoader.
    
    Returns:
    
    A new StandardLoader, initialized with proper context for its type.
  - buildStdPropFileOnClasspathLoader
```
protected StdPropFileOnClasspathLoader buildStdPropFileOnClasspathLoader()
```
    Build a StdPropFileOnClasspathLoader, passing it the needed context. This method, like the other buildStd....Loader methods is called based on the class name of a StandardLoader.
    
    Returns:
    
    A new StandardLoader, initialized with proper context for its type.
  - buildLoaders
```
public List<Loader> buildLoaders()
```
    Specified by:
    
    buildLoaders in interface AndHowConfiguration<C extends BaseConfig<C>>
  - getRegisteredGroups
```
public List<GroupProxy> getRegisteredGroups()
```
    Description copied from interface: AndHowConfiguration
    
    Return a custom list of 'Groups' (classes or interfaces containing AndHow Properties) to use instead of allowing the auto-discovery to find the Groups. AndHow will use a ServiceLoader to discover all classes containing AndHow Properties in conjunction with a generated manifest of those classes created at compile time. Each class containing at least one AndHow Property is called a Group and is represented by a GroupProxy object.
    If this method returns non-null, then AndHow does not use this auto-discovery mechanism and just uses the returned list of GroupProxies. This is primarily for testing, where it is useful to test on only a small set of Groups and Properties.
    Returning an empty list from this method would result in AndHow initializing with no registered Groups.
    
    Specified by:
    
    getRegisteredGroups in interface AndHowConfiguration<C extends BaseConfig<C>>
    
    Returns:
    
    A list of GroupProxies to use instead of the auto-discovery process. May return null (and normally does) to allow the normal auto-discovery to happen.
  - getDefaultLoaderList
```
public List<Class<? extends StandardLoader>> getDefaultLoaderList()
```
    Description copied from interface: AndHowConfiguration
    The default list of standard loaders, as a list of Classes that implement StandardLoader
    The returned list is disconnected from the actual list of loaders - it is intended to be a starting point for applications that want to modify the list, then call setStandardLoaders().
    Unlike other methods of this class, it does not fluently return a method to itself, so your code will need a AndHowConfiguration instance reference to use it, eg:
```
     
 public class MyAppInitiation implements AndHowInit {
     @Override
        public AndHowConfiguration getConfiguration() {
                        AndHowConfiguration config = AndHow.findConfig();
                         List<Class<? extends StandardLoader>> sll = config.getDefaultLoaderList();
                        ...do some rearranging of the list...

                        config.setStandardLoaders(sll) ...and go on to call other methods on config...
                }
 }
     
 
```
    Note: AndHow version up to and including 0.4.1 had this method as a static method.
    Specified by:
    
    getDefaultLoaderList in interface AndHowConfiguration<C extends BaseConfig<C>>
    
    Returns:
  - getLoaderEnvironment
```
public LoaderEnvironment getLoaderEnvironment()
```
    Returns an immutable LoaderEnvironment with all collections fully expanded.
    Collections like environmental vars and system props, which may have been empty because they were not explicitly set, will be replaced with the actual env vars or sys props in the returned immutable version. Thus, the LoaderEnvironment returned from this method may not match the individual accessor methods of the LoaderEnvironmentBuilder.
    
    Specified by:
    
    getLoaderEnvironment in interface AndHowConfiguration<C extends BaseConfig<C>>
    
    Returns:
    
    An immutable and fully expanded LoaderEnvironment.

Class BaseConfig<C extends BaseConfig<C>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.yarnandtail.andhow.AndHowConfiguration

Field Detail

DEFAULT_LOADER_LIST

standardLoaders

insertBefore

insertAfter

loadEnvBuilder

classpathPropFilePathStr

classpathPropFilePathProp

_missingClasspathPropFileAProblem

filesystemPropFilePathProp

_missingFilesystemPropFileAProblem

naming

overrideGroups

Constructor Detail

BaseConfig

Method Detail

getNamingStrategy

buildStdFixedValueLoader

buildStdMainStringArgsLoader

buildStdSysPropLoader

buildStdJndiLoader

buildStdEnvVarLoader

buildStdPropFileOnFilesystemLoader

buildStdPropFileOnClasspathLoader

buildLoaders

getRegisteredGroups

getDefaultLoaderList

getLoaderEnvironment