org.yarnandtail.andhow.sample

Class BaseSamplePrinter

java.lang.Object

org.yarnandtail.andhow.sample.BaseSamplePrinter

All Implemented Interfaces:

SamplePrinter

Direct Known Subclasses:

JndiLoaderSamplePrinter, PropFileLoaderSamplePrinter

public abstract class BaseSamplePrinter
extends Object
implements SamplePrinter

Author:

ericeverman

Field Summary

Fields inherited from interface org.yarnandtail.andhow.api.SamplePrinter

DEFAULT_VALUE_TEXT, REQUIRED_HEADER_TEXT, REQUIRED_KEYWORD, THE_VALUE_MUST_TEXT

Constructor Summary

Constructors

Constructor and Description
BaseSamplePrinter()

Method Summary

Modifier and Type	Method and Description
abstract TextBlock	getActualProperty(ConstructionDefinition definition, Class<? extends BasePropertyGroup> group, Property prop)
abstract String	getInAliaseString(ConstructionDefinition definition, EffectiveName name)
abstract TextBlock	getSampleFileEnd()
abstract TextBlock	getSampleFileStart()
abstract TextBlock	getSampleStartComment(ConstructionDefinition definition) Must provide its own line comment prefix if the format has no block comment.
protected void	print(PrintStream out, TextBlock block, PrintFormat format)
protected void	printIfNotNull(PrintStream out, String line)
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)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseSamplePrinter

public BaseSamplePrinter()

Method Detail

getSampleFileStart

public abstract TextBlock getSampleFileStart()

getSampleStartComment

public abstract TextBlock getSampleStartComment(ConstructionDefinition definition)

Must provide its own line comment prefix if the format has no block comment.

Returns:

getInAliaseString

public abstract String getInAliaseString(ConstructionDefinition definition,
                                         EffectiveName name)

getActualProperty

public abstract TextBlock getActualProperty(ConstructionDefinition definition,
                                            Class<? extends BasePropertyGroup> group,
                                            Property prop)
                                     throws Exception

Throws:

Exception

getSampleFileEnd

public abstract TextBlock getSampleFileEnd()

printIfNotNull

protected void printIfNotNull(PrintStream out,
                              String line)

print

protected void print(PrintStream out,
                     TextBlock block,
                     PrintFormat format)

printSampleStart

public void printSampleStart(ConstructionDefinition definition,
                             PrintStream out)

Specified by:

printSampleStart in interface SamplePrinter

printPropertyGroupStart

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

Specified by:

printPropertyGroupStart in interface SamplePrinter

printProperty

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

Specified by:

printProperty in interface SamplePrinter

printPropertyGroupEnd

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

Specified by:

printPropertyGroupEnd in interface SamplePrinter

printSampleEnd

public void printSampleEnd(ConstructionDefinition definition,
                           PrintStream out)

Specified by:

printSampleEnd in interface SamplePrinter