org.yarnandtail.andhow.api

Interface SamplePrinter

All Known Implementing Classes:

BaseSamplePrinter, JndiLoaderSamplePrinter, PropFileLoaderSamplePrinter

public interface SamplePrinter

Statelessly writes a sample configuration to the passed in PrintStream. Implementers may be invoked by request or when configuration initiation fails. Each type of configuration source has a Loader associated with it, and that loader can have a SamplePrinter instance associated with it so that when a particular loader is used (such as a properties file loader), its possible to print a sample configuration if the startup fails.

Author:

ericeverman

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VALUE_TEXT Lead-in for a default value
static String	REQUIRED_HEADER_TEXT A general explanation for a sample header of what a required property is
static String	REQUIRED_KEYWORD Required properties will be marked w/ this text in the sample
static String	THE_VALUE_MUST_TEXT Lead-in text for validation requirements

Method Summary

Modifier and Type	Method and Description
void	printProperty(ConstructionDefinition definition, PrintStream out, Class<? extends BasePropertyGroup> group, Property<?> prop)
void	printPropertyGroupEnd(ConstructionDefinition definition, PrintStream out, Class<? extends BasePropertyGroup> group)
void	printPropertyGroupStart(ConstructionDefinition definition, PrintStream out, Class<? extends BasePropertyGroup> group)
void	printSampleEnd(ConstructionDefinition definition, PrintStream out)
void	printSampleStart(ConstructionDefinition definition, PrintStream out)

Field Detail

REQUIRED_KEYWORD

static final String REQUIRED_KEYWORD

Required properties will be marked w/ this text in the sample

See Also:

Constant Field Values

REQUIRED_HEADER_TEXT

static final String REQUIRED_HEADER_TEXT

A general explanation for a sample header of what a required property is

See Also:

Constant Field Values

THE_VALUE_MUST_TEXT

static final String THE_VALUE_MUST_TEXT

Lead-in text for validation requirements

See Also:

Constant Field Values

DEFAULT_VALUE_TEXT

static final String DEFAULT_VALUE_TEXT

Lead-in for a default value

See Also:

Constant Field Values

Method Detail

printSampleStart

void printSampleStart(ConstructionDefinition definition,
                      PrintStream out)

printPropertyGroupStart

void printPropertyGroupStart(ConstructionDefinition definition,
                             PrintStream out,
                             Class<? extends BasePropertyGroup> group)

printProperty

void printProperty(ConstructionDefinition definition,
                   PrintStream out,
                   Class<? extends BasePropertyGroup> group,
                   Property<?> prop)

printPropertyGroupEnd

void printPropertyGroupEnd(ConstructionDefinition definition,
                           PrintStream out,
                           Class<? extends BasePropertyGroup> group)

printSampleEnd

void printSampleEnd(ConstructionDefinition definition,
                    PrintStream out)