org.yarnandtail.andhow.service

Interface PropertyRegistrar

All Known Implementing Classes:

AbstractPropertyRegistrar

public interface PropertyRegistrar

Basic interface used by the java.util.ServiceLoader to discover all implementations on the classpath.

At compile time, instances of this interface are generated and added to the final artifact (typically a jar, war or ear file), which can be discovered automatically via the java.util.ServiceLoader mechanism.

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

Method Summary

Modifier and Type	Method and Description
List<PropertyRegistration>	getRegistrationList() Get the list if individual Property registrations.
String	getRootCanonicalName() The Java canonical name of a root class containing AndHow Properties.

Method Detail

getRootCanonicalName

String getRootCanonicalName()

The Java canonical name of a root class containing AndHow Properties.

A 'root' class is a non-inner class. All inner classes would be recored together under the root class.

Returns:

getRegistrationList

List<PropertyRegistration> getRegistrationList()

Get the list if individual Property registrations.

Returns:

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