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
String	getSampleFileExtension() The file extention to use for sample files, eg 'properties' or 'xml'.
void	printProperty(StaticPropertyConfigurationInternal definition, PrintStream out, GroupProxy group, Property<?> prop)
void	printPropertyGroupEnd(StaticPropertyConfigurationInternal definition, PrintStream out, GroupProxy group)
void	printPropertyGroupStart(StaticPropertyConfigurationInternal definition, PrintStream out, GroupProxy group)
void	printSampleEnd(StaticPropertyConfigurationInternal definition, PrintStream out)
void	printSampleStart(StaticPropertyConfigurationInternal 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(StaticPropertyConfigurationInternal definition,
                      PrintStream out)

printPropertyGroupStart

void printPropertyGroupStart(StaticPropertyConfigurationInternal definition,
                             PrintStream out,
                             GroupProxy group)

printProperty

void printProperty(StaticPropertyConfigurationInternal definition,
                   PrintStream out,
                   GroupProxy group,
                   Property<?> prop)

printPropertyGroupEnd

void printPropertyGroupEnd(StaticPropertyConfigurationInternal definition,
                           PrintStream out,
                           GroupProxy group)

printSampleEnd

void printSampleEnd(StaticPropertyConfigurationInternal definition,
                    PrintStream out)

getSampleFileExtension

String getSampleFileExtension()

The file extention to use for sample files, eg 'properties' or 'xml'.

Returns: