org.yarnandtail.andhow.export

Class BaseExporter

java.lang.Object

org.yarnandtail.andhow.export.BaseExporter

All Implemented Interfaces:

Exporter

Direct Known Subclasses:

SysPropExporter

public abstract class BaseExporter
extends Object
implements Exporter

All implementations must have a zero argument constructor.

Author:

ericeverman

Nested Class Summary

Nested classes/interfaces inherited from interface org.yarnandtail.andhow.api.Exporter

Exporter.EXPORT_CANONICAL_NAME, Exporter.EXPORT_OUT_ALIASES

Field Summary

Fields

Modifier and Type	Field and Description
protected Exporter.EXPORT_CANONICAL_NAME	includeCanonical
protected Exporter.EXPORT_OUT_ALIASES	includeOutAlias

Constructor Summary

Constructors

Constructor and Description
BaseExporter()

Method Summary

Modifier and Type	Method and Description
abstract <T> void	doExport(String name, Property<T> property, PropertyConfigurationInternal definition, ValidatedValues values) Subclasses can implement just this method.
void	export(GroupProxy group, PropertyConfigurationInternal definition, ValidatedValues values) Exports a Group.
void	export(Property<?> property, PropertyConfigurationInternal definition, ValidatedValues values)
protected boolean	hasOutAlias(Property<?> property, PropertyConfigurationInternal definition)
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yarnandtail.andhow.api.Exporter

export

Field Detail

includeCanonical

protected Exporter.EXPORT_CANONICAL_NAME includeCanonical

includeOutAlias

protected Exporter.EXPORT_OUT_ALIASES includeOutAlias

Constructor Detail

BaseExporter

public BaseExporter()

Method Detail

setExportByOutAliases

public void setExportByOutAliases(Exporter.EXPORT_OUT_ALIASES option)

Description copied from interface: Exporter

Specify if out alias names should be exported.

Specified by:

setExportByOutAliases in interface Exporter

setExportByCanonicalName

public void setExportByCanonicalName(Exporter.EXPORT_CANONICAL_NAME option)

Description copied from interface: Exporter

Specify if canonical names should be exported.

Specified by:

setExportByCanonicalName in interface Exporter

doExport

public abstract <T> void doExport(String name,
                                  Property<T> property,
                                  PropertyConfigurationInternal definition,
                                  ValidatedValues values)

Subclasses can implement just this method.

Parameters:

name -

property -

definition -

values -

export

public void export(GroupProxy group,
                   PropertyConfigurationInternal definition,
                   ValidatedValues values)

Description copied from interface: Exporter

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.

Specified by:

export in interface Exporter

export

public void export(Property<?> property,
                   PropertyConfigurationInternal definition,
                   ValidatedValues values)

hasOutAlias

protected boolean hasOutAlias(Property<?> property,
                              PropertyConfigurationInternal definition)