org.yarnandtail.andhow.internal.export

Class ManualExportService

java.lang.Object

org.yarnandtail.andhow.internal.export.ManualExportService

public class ManualExportService
extends Object

A service for performing a manual export.

Manual exports are initiated via AndHow.export(Class[]) - See that method for usage details and examples.

Constructor Summary

Constructors

Constructor and Description
ManualExportService()

Method Summary

Modifier and Type	Method and Description
Stream<PropertyExport>	doManualExport(List<Class<?>> exportRoots, Collection<GroupProxy> groupList) Perform an export for a list of Classes.
protected void	exportClass(Class<?> clazz, Exporter.EXPORT_CANONICAL_NAME canNameOpt, Exporter.EXPORT_OUT_ALIASES outAliasOpt, Collection<GroupProxy> groupList, Collection<PropertyExport> propExports) Export the Properties contained in a single class with no recursion.
protected void	exportClassAndChildren(Class<?> clazz, Exporter.EXPORT_CANONICAL_NAME canonicalOption, Exporter.EXPORT_OUT_ALIASES outAliasOption, Set<Class<?>> alreadyExportedClasses, Collection<GroupProxy> groupList, Collection<PropertyExport> propExports) Export this class and all contained, nested inner classes if permitted.
protected Optional<ManualExportAllowed>	findEffectiveAllowAnnotation(Class<?> clazz) Returns the effective ManualExportAllowed annotation instance if it exists.
protected Optional<ManualExportAllowed>	getAllowAnnotation(Class<?> clazz) Gets the ManualExportAllowed annotation directly on this class.
protected boolean	isManualExportDisallowed(Class<?> clazz) Returns true if manual export is explicitly annotated to not be allowed on this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManualExportService

public ManualExportService()

Method Detail

doManualExport

public Stream<PropertyExport> doManualExport(List<Class<?>> exportRoots,
                                             Collection<GroupProxy> groupList)
                                      throws IllegalAccessException

Perform an export for a list of Classes.

An export takes place as follows:

• Each the classes in the list of exportRoots is processed sequentially
• If the class is not annotated with ManualExportAllowed, an exception is thrown.
• Calling to exportClassAndChildren(java.lang.Class<?>, org.yarnandtail.andhow.api.Exporter.EXPORT_CANONICAL_NAME, org.yarnandtail.andhow.api.Exporter.EXPORT_OUT_ALIASES, java.util.Set<java.lang.Class<?>>, java.util.Collection<org.yarnandtail.andhow.api.GroupProxy>, java.util.Collection<org.yarnandtail.andhow.export.PropertyExport>), all Propertys in the class are discovered and a PropertyExport instance made for each one.
• Any inner classes are discovered and also exported, checking to see if they have a ManualExportAllowed annotation that might set different export options.

A list of all classes that have been exported is kept to prevent overlapping classes from creating duplicate exports, e.g. if a class and an innerclass of that class are included in the exportRoots list, the result should still not have duplicates.

Only classes for which a GroupProxy exists have Properties and the proxies have the list of Properties contained in each class.

Parameters:

exportRoots - The list of classes who's Properties should be exported.

groupList - The list of GroupProxy's, created during AndHow initialization.

Returns:

A Stream to be mapped, filtered & collected as needed.

Throws:

IllegalAccessException - If any of the exportRoots are not annotated (directly or indirectly via a containing class) with ManualExportAllowed.

exportClassAndChildren

protected void exportClassAndChildren(Class<?> clazz,
                                      Exporter.EXPORT_CANONICAL_NAME canonicalOption,
                                      Exporter.EXPORT_OUT_ALIASES outAliasOption,
                                      Set<Class<?>> alreadyExportedClasses,
                                      Collection<GroupProxy> groupList,
                                      Collection<PropertyExport> propExports)

Export this class and all contained, nested inner classes if permitted. The clazz and the effective canonicalOption & outAliasOption export options must match and the passed clazz and must be legal to export as defined by findEffectiveAllowAnnotation(java.lang.Class<?>), otherwise incorrect export options will be used and/or non-exportable (ie private) Properties exported.

Contained classes that are discovered and annotated with ManualExportNotAllowed will not be exported and no further search within those classes is performed.

The alreadyExportedClasses collection is used to prevent export of classes already exported. This can happen when this method is called on a list of classes, some of which may overlap in their contained classes.

Parameters:

clazz - The class (and potentially its contained classes) to export.

canonicalOption - The option as annotated on passed class or a class that contains it.

outAliasOption - The option as annotated on passed class or a class that contains it.

alreadyExportedClasses - Class which have already been exported, to prevent duplicate exports when a user passes classes nested classes (i.e. a parent class and an inner class).

exportClass

protected void exportClass(Class<?> clazz,
                           Exporter.EXPORT_CANONICAL_NAME canNameOpt,
                           Exporter.EXPORT_OUT_ALIASES outAliasOpt,
                           Collection<GroupProxy> groupList,
                           Collection<PropertyExport> propExports)

Export the Properties contained in a single class with no recursion.

Parameters:

clazz - The class to export

canNameOpt - canonical name option

outAliasOpt - out alias names option

groupList - The GroupProxy collection, created during AndHow initialization.

propExports - The collection to add the exports to, one per Property.

findEffectiveAllowAnnotation

protected Optional<ManualExportAllowed> findEffectiveAllowAnnotation(Class<?> clazz)
                                                              throws IllegalStateException

Returns the effective ManualExportAllowed annotation instance if it exists.

The effective annotation may be on the clazz itself or a containing class if the clazz is an inner class. If no annotation is found or a ManualExportNotAllowed annotation is found closer in the inner class hierarchy, then this class is not manually exportable.

Parameters:

clazz - Determine if this class or its container is annotated for manual export.

Returns:

The Optional ManualExportAllowed annotation, if it exists.

Throws:

IllegalStateException - If this class is annotated to both allow and disallow manual exports.

getAllowAnnotation

protected Optional<ManualExportAllowed> getAllowAnnotation(Class<?> clazz)

Gets the ManualExportAllowed annotation directly on this class.

Parameters:

clazz - The class to find the annotation on.

Returns:

An Optional if the annotation exists.

isManualExportDisallowed

protected boolean isManualExportDisallowed(Class<?> clazz)

Returns true if manual export is explicitly annotated to not be allowed on this class.

This does not consider containing classes, it only checks if there is a 'not allowed' annotation on this class exclusively.

Parameters:

clazz - The class to check

Returns:

True if manual exports are explicitly not allowed on this class.