org.yarnandtail.andhow.service

Class AbstractPropertyRegistrar

java.lang.Object

org.yarnandtail.andhow.service.AbstractPropertyRegistrar

All Implemented Interfaces:

PropertyRegistrar

public abstract class AbstractPropertyRegistrar
extends Object
implements PropertyRegistrar

Provides a minimal implementation of PropertyRegistrar to simplify code that must be generated.

Property registration background

At compile time, the AndHowCompileProcessor (an annotation Processor), reads user classes and generates a PropertyRegistrar instance for each root class (non-inner class) that contains an AndHow Property. Matching service files are also generated in the "META-INF/services/" directory so the PropertyRegistrar instances can be discovered through the java.util.ServiceLoader mechanism.

At run time, the PropertyRegistrarLoader discovers all PropertyRegistrar instances. Each PropertyRegistrar creates a PropertyRegistrationList instance with a PropertyRegistration for each Property present in the jar.

Author:

ericeverman

Constructor Summary

Constructors

Constructor and Description
AbstractPropertyRegistrar()

Method Summary

Modifier and Type	Method and Description
abstract void	addPropertyRegistrations(PropertyRegistrationList list) Can be used by subclasses to build the property registration list.
List<PropertyRegistration>	getRegistrationList() Get the list if individual Property registrations.

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.service.PropertyRegistrar

getRootCanonicalName

Constructor Detail

AbstractPropertyRegistrar

public AbstractPropertyRegistrar()

Method Detail

getRegistrationList

public List<PropertyRegistration> getRegistrationList()

Description copied from interface: PropertyRegistrar

Get the list if individual Property registrations.

Specified by:

getRegistrationList in interface PropertyRegistrar

Returns:

A list of registrations. The list may be unmodifiable or detached.

addPropertyRegistrations

public abstract void addPropertyRegistrations(PropertyRegistrationList list)

Can be used by subclasses to build the property registration list.

This method will be called by getRegistrationList with an empty list. Implementers can then add each registration to the list.

Parameters:

list - The list to add PropertyRegistrations to. For consistency, registrations should be added in the order they were encoded in the PropertyRegistrar instance.