org.yarnandtail.andhow.service

Class PropertyRegistrarLoader

java.lang.Object

org.yarnandtail.andhow.service.PropertyRegistrarLoader

public class PropertyRegistrarLoader
extends Object

Dedicated wrapper for a java.util.ServiceLoader that loads PropertyRegistrar instances. PropertyRegistrar instances are generated automatically at compile time for classes using AndHow properties. When a PropertyRegistrar is created, it is recorded as a Service, making it visible to the ServiceLoader.

Constructor Summary

Constructors

Constructor and Description
PropertyRegistrarLoader() New instance with default class loader (class.getClassLoader())
PropertyRegistrarLoader(ClassLoader classLoader) New instance w/ specific classloader

Method Summary

Modifier and Type	Method and Description
List<GroupProxy>	getGroups() Returns a newly created list of GroupProxys.
List<PropertyRegistrar>	getPropertyRegistrars() Returns a newly created list of PropertyRegistrars.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertyRegistrarLoader

public PropertyRegistrarLoader()

New instance with default class loader (class.getClassLoader())

PropertyRegistrarLoader

public PropertyRegistrarLoader(ClassLoader classLoader)

New instance w/ specific classloader

Parameters:

classLoader - Classloader to use to locate PropertyRegistration instances.

Method Detail

getPropertyRegistrars

public List<PropertyRegistrar> getPropertyRegistrars()

Returns a newly created list of PropertyRegistrars.

The PropertyRegistrar instances are created from the complete set of PropertyRegistrar implementations on the classpath. This is a complete list as provided by the java.util.ServiceLoader.

Even though the list is newly created each time this method is called, the instances of PropertyRegistrars are the same across all lists. During a typical application lifecycle, this method would only be called once, though there is no impact to calling it multiple times.

Returns:

A disconnected list of PropertyRegistrars.

getGroups

public List<GroupProxy> getGroups()

Returns a newly created list of GroupProxys.

The GroupProxy instances are created from the complete set of PropertyRegistrar implementations on the classpath. This is a complete list as provided by the java.util.ServiceLoader.

The list and the GroupProxy instances are freshly created for each call to this method. During a typical application lifecycle, this method would only be called once, though there is no impact to calling it multiple times. The contained Propertys are static instances for which there will ever only be a single instance.

Returns:

A disconnected, editable and non-null list of GroupProxys.