org.yarnandtail.andhow.load

Class BaseLoader

java.lang.Object

org.yarnandtail.andhow.load.BaseLoader

All Implemented Interfaces:

Loader

Direct Known Subclasses:

EnviromentVariableLoader, FixedValueLoader, JndiLoader, PropertyFileBaseLoader, StringArgumentLoader, SystemPropertyLoader

public abstract class BaseLoader
extends Object
implements Loader

Author:

eeverman

Constructor Summary

Constructors

Constructor and Description
BaseLoader()

Method Summary

Modifier and Type	Method and Description
protected void	attemptToAdd(ConstructionDefinition appConfigDef, List<PropertyValue> values, ProblemList<Problem> loaderProblems, Property prop, Object value) Util method to attempt to load an object of an unknown type to a property.
protected void	attemptToAdd(ConstructionDefinition appConfigDef, List<PropertyValue> values, ProblemList<Problem> loaderProblems, String key, String strValue) Util method to load a String to a property by name.
protected <T> PropertyValue	createValue(ConstructionDefinition appConfigDef, Property<T> prop, String untrimmedString)
protected PropertyValue	findDuplicateProperty(PropertyValue current, List<PropertyValue> values)
Class<? extends BasePropertyGroup>	getClassConfig() A group of Properties used to globally configure all instance of a type of loader.
SamplePrinter	getConfigSamplePrinter() Returns a ConfigSamplePrinter, which can be used to print a configuration sample for this Loader.
List<Property>	getInstanceConfig() A list of properties that the user has specified as being configuration properties for this Loader.

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.api.Loader

getLoaderDialect, getLoaderType, getSpecificLoadDescription, isTrimmingRequiredForStringValues, isUnrecognizedPropertyNamesConsideredAProblem, load

Constructor Detail

BaseLoader

public BaseLoader()

Method Detail

getClassConfig

public Class<? extends BasePropertyGroup> getClassConfig()

Description copied from interface: Loader

A group of Properties used to globally configure all instance of a type of loader. For loaders that are intended to be single instance (i.e. a JNDI loader) or loaders that can be multi-instance (PropertyFile loaders) but need to share some common configuration can return a BasePropertyGroup from this method that is their global configuration interface. For configuration properties that should vary between instances of the same loader class, accept them in the Loader constructor. (See getInstanceConfig) The BasePropertyGroup returned from this method will be included in sample config files. It is up to the Loader class to read from those configured properties if the user configures them.

Specified by:

getClassConfig in interface Loader

Returns:

getInstanceConfig

public List<Property> getInstanceConfig()

Description copied from interface: Loader

A list of properties that the user has specified as being configuration properties for this Loader. Typically these Properties have been specified in the Loader constructor or builder. An example usage would be passing in a Property that specifies the location of a properties file to read from. This is the preferred way to configure a loader because its clear to the user and it allows each instance of a loader to be configured differently, e.g., so PropertyFile loaders that load from different locations. Any Properties returned from this method must have been registered for configuration.

Specified by:

getInstanceConfig in interface Loader

Returns:

Never null. Either an empty list or populated.

getConfigSamplePrinter

public SamplePrinter getConfigSamplePrinter()

Description copied from interface: Loader

Returns a ConfigSamplePrinter, which can be used to print a configuration sample for this Loader. This method may return null if there is no sample printer for this loader.

Specified by:

getConfigSamplePrinter in interface Loader

Returns:

attemptToAdd

protected void attemptToAdd(ConstructionDefinition appConfigDef,
                            List<PropertyValue> values,
                            ProblemList<Problem> loaderProblems,
                            String key,
                            String strValue)

Util method to load a String to a property by name. Used for text based loaders.

Parameters:

appConfigDef - Used to look up the property name for find the actual property

values - List of PropertyValues to add to, which should be only the value of this loader.

loaderProblems - A list of Problems to add to if there is a loader related problem

key - The property name

strValue - The property value

attemptToAdd

protected void attemptToAdd(ConstructionDefinition appConfigDef,
                            List<PropertyValue> values,
                            ProblemList<Problem> loaderProblems,
                            Property prop,
                            Object value)

Util method to attempt to load an object of an unknown type to a property. Used for object based loaders where value are not in text form. This loader assumes the passed property is a valid property to to load to, but it will check to make sure it is not null, which is not treated as an error.

Parameters:

appConfigDef - Used to look up the property name for find the actual property

values - List of PropertyValues to add to, which should be only the value of this loader.

loaderProblems - A list of LoaderProblems to add to if there is a loader related problem

prop - The Property to load to

value - The Object to be loaded to this property

findDuplicateProperty

protected PropertyValue findDuplicateProperty(PropertyValue current,
                                              List<PropertyValue> values)

createValue

protected <T> PropertyValue createValue(ConstructionDefinition appConfigDef,
                                        Property<T> prop,
                                        String untrimmedString)
                                 throws ParsingException

Throws:

ParsingException