org.yarnandtail.andhow.api

Interface Exporter

All Known Implementing Classes:

BaseExporter, SysPropExporter

public interface Exporter

The Exporter provides support for legacy applications that expect to find key/value pairs in a specific source, such as system properties. This allows applications to use AndHow for configuration and still maintain compatibility with legacy modules/libraries. New code can begin to use the direct Property access that AndHow provides. Exporting is considered 'safe', so overlapping export configuration, such as application level and BasePropertyGroup level are read permissively.

Author:

ericeverman

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Exporter.EXPORT_CANONICAL_NAME
static class	Exporter.EXPORT_OUT_ALIASES

Method Summary

Modifier and Type	Method and Description
void	export(Class<? extends BasePropertyGroup> group, ConstructionDefinition definition, ValueMap values) Exports a BasePropertyGroup.
void	export(ConstructionDefinition definition, ValueMap values) Exports all properties.
void	setExportByCanonicalName(Exporter.EXPORT_CANONICAL_NAME option) Specify if canonical names should be exported.
void	setExportByOutAliases(Exporter.EXPORT_OUT_ALIASES option) Specify if out alias names should be exported.

Method Detail

setExportByCanonicalName

void setExportByCanonicalName(Exporter.EXPORT_CANONICAL_NAME option)

Specify if canonical names should be exported.

Parameters:

option -

setExportByOutAliases

void setExportByOutAliases(Exporter.EXPORT_OUT_ALIASES option)

Specify if out alias names should be exported.

Parameters:

option -

export

void export(ConstructionDefinition definition,
            ValueMap values)

Exports all properties. Based on its configuration, an exporter can decide which properties should be exported and what name or aliases should be used when exporting.

Parameters:

definition -

values -

export

void export(Class<? extends BasePropertyGroup> group,
            ConstructionDefinition definition,
            ValueMap values)

Exports a BasePropertyGroup. Based on its configuration, an exporter can decide which properties should be exported and what name or aliases should be used when exporting.

Parameters:

group -

definition -

values -