org.yarnandtail.andhow.api

Interface Exporter

All Known Implementing Classes:

BaseExporter, SysPropExporter

public interface Exporter

An Exporter exports property names and values for classes that are annotated with GroupExport.

An example is the SysPropExporter, which exports properties to System.Properties.

Exporters are passed the list Properties contained directly in the annotated class, not Properties contained in nested inner classes.

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(GroupProxy group, PropertyConfigurationInternal definition, ValidatedValues values) Exports a Group.
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(GroupProxy group,
            PropertyConfigurationInternal definition,
            ValidatedValues values)

Exports a Group. 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 -