org.yarnandtail.andhow.sample

Class PropFileLoaderSamplePrinter

java.lang.Object

org.yarnandtail.andhow.sample.BaseSamplePrinter

org.yarnandtail.andhow.sample.PropFileLoaderSamplePrinter

All Implemented Interfaces:

SamplePrinter

public class PropFileLoaderSamplePrinter
extends BaseSamplePrinter
implements SamplePrinter

Prints configuration templates for properties files.

Field Summary

Fields

Modifier and Type	Field and Description
protected PrintFormat	format

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
PropFileLoaderSamplePrinter()

Method Summary

Modifier and Type	Method and Description
TextBlock	getActualProperty(PropertyConfigurationInternal definition, GroupProxy group, Property prop)
PrintFormat	getFormat()
String	getInAliaseString(PropertyConfigurationInternal definition, EffectiveName name)
TextBlock	getSampleFileEnd()
String	getSampleFileExtension() The file extention to use for sample files, eg 'properties' or 'xml'.
TextBlock	getSampleFileStart()
TextBlock	getSampleStartComment(PropertyConfigurationInternal definition) Must provide its own line comment prefix if the format has no block comment.

Methods inherited from class org.yarnandtail.andhow.sample.BaseSamplePrinter

print, printProperty, printPropertyGroupEnd, printPropertyGroupStart, printSampleEnd, printSampleStart

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.SamplePrinter

printProperty, printPropertyGroupEnd, printPropertyGroupStart, printSampleEnd, printSampleStart

Field Detail

format

protected PrintFormat format

Constructor Detail

PropFileLoaderSamplePrinter

public PropFileLoaderSamplePrinter()

Method Detail

getFormat

public PrintFormat getFormat()

getSampleFileStart

public TextBlock getSampleFileStart()

Specified by:

getSampleFileStart in class BaseSamplePrinter

getSampleStartComment

public TextBlock getSampleStartComment(PropertyConfigurationInternal definition)

Description copied from class: BaseSamplePrinter

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

Specified by:

getSampleStartComment in class BaseSamplePrinter

Returns:

getInAliaseString

public String getInAliaseString(PropertyConfigurationInternal definition,
                                EffectiveName name)

Specified by:

getInAliaseString in class BaseSamplePrinter

getActualProperty

public TextBlock getActualProperty(PropertyConfigurationInternal definition,
                                   GroupProxy group,
                                   Property prop)
                            throws Exception

Specified by:

getActualProperty in class BaseSamplePrinter

Throws:

Exception

getSampleFileEnd

public TextBlock getSampleFileEnd()

Specified by:

getSampleFileEnd in class BaseSamplePrinter

getSampleFileExtension

public String getSampleFileExtension()

Description copied from interface: SamplePrinter

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

Specified by:

getSampleFileExtension in interface SamplePrinter

Returns: