org.yarnandtail.andhow.service

Class PropertyRegistrationList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<PropertyRegistration>

org.yarnandtail.andhow.service.PropertyRegistrationList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<PropertyRegistration>, Collection<PropertyRegistration>, List<PropertyRegistration>, RandomAccess

public class PropertyRegistrationList
extends ArrayList<PropertyRegistration>

A List of Registrations with simplified add methods that make it efficient (source code wise) to add Registrations.

Registrations that share the same inner path (that is, the same nested inner class parents) can just be added with no inner path specified and they will be assumed to use the same path as the previous entry.

Since the source code that calls these add methods is generated and potentially verbose, its nice to have an efficient way to do it.

This class is modifiable and it is assumed that a new list is generated each time it is requested, ie, an instance is constructed directly in a 'get' method. The get method will likely only be called once during its lifecycle.

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.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
PropertyRegistrationList(String classCanonName) Construct a new registration list for properties in a specific top level class.

Method Summary

Modifier and Type	Method and Description
boolean	add(PropertyRegistration reg) Adds a registration using the innerPath specified in the passed registration.
boolean	add(String name) Adds a property registration with the same path as the previously added one.
boolean	add(String name, List<String> innerPath) Adds a property registration with a specified path.
boolean	add(String name, String... innerPath) Adds a property registration with a specified path.
String	getRootCanonicalName() The root / top level class which contains (either directly or indirectly) the properties listed within it.
void	sort() Sorts in lexagraphical order.

Methods inherited from class java.util.ArrayList

add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

PropertyRegistrationList

public PropertyRegistrationList(String classCanonName)

Construct a new registration list for properties in a specific top level class.

Parameters:

classCanonName - The fully qualified canonical path of the root class.

Method Detail

getRootCanonicalName

public String getRootCanonicalName()

The root / top level class which contains (either directly or indirectly) the properties listed within it.

Returns:

The Java canonical name of the root class.

add

public boolean add(PropertyRegistration reg)

Adds a registration using the innerPath specified in the passed registration. Even if the passed registration has a null or empty inner path, it will be assumed to be correct, meaning a root property.

Specified by:

add in interface Collection<PropertyRegistration>

Specified by:

add in interface List<PropertyRegistration>

Overrides:

add in class ArrayList<PropertyRegistration>

Parameters:

reg - The PropertyRegistration to add to the end of the list.

Returns:

True if it was added (it is always added).

add

public boolean add(String name)

Adds a property registration with the same path as the previously added one. If there is no previous registration, it is assumed to be a root (within the current top level class) proerty.

Parameters:

name - Name of the AndHow property, which is the name of the variable it is assigned to at construction.

Returns:

True if it was added (it is always added).

add

public boolean add(String name,
                   String... innerPath)

Adds a property registration with a specified path. Following calls to add(propName) will use this same path. Passing an empty innerPath array is interpreted as a property at the root.

Parameters:

name - Name of the AndHow property, which is the name of the variable it is assigned to at construction.

innerPath -

Returns:

True if it was added (it is always added).

add

public boolean add(String name,
                   List<String> innerPath)

Adds a property registration with a specified path. Following calls to add(propName) will use this same path. Passing an empty innerPath array is interpreted as a property at the root.

Parameters:

name - Name of the AndHow property, which is the name of the variable it is assigned to at construction.

innerPath - The 'path' of nested inner class/interfaces from outer to inner

Returns:

True if it was added (it is always added).

sort

public void sort()

Sorts in lexagraphical order.