Interface TemplateCustomization
-
- All Known Implementing Classes:
AbstractTemplateCustomization,AsciiDocTemplateCustomization,HtmlTemplateCustomization,MarkdownTemplateCustomization,XmlTemplateCustomization
public interface TemplateCustomizationClass represents a template customization object.- Since:
- 0.2.0
- Author:
- nandorholozsnyak
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetLocale()Returns the set locale.StringgetTocTitle()Returns the 'Table of Contents' section title.StringgetUnknownGroupLocalization()Returns the title for the unknown group.booleanisIncludeEnvFormat()If the properties should be converted to their environment variable representation to have a quicker way to copy and paste them.booleanisIncludeGenerationDate()If the generation date should be rendered into the document or not.booleanisIncludeUnknownGroup()If the unknown group should be included or not in the final rendered document or not.booleanisRemoveEmptyGroups()If empty groups must be removed from the final document or not.
-
-
-
Method Detail
-
getTocTitle
String getTocTitle()
Returns the 'Table of Contents' section title.- Since:
- 0.4.0
-
isIncludeUnknownGroup
boolean isIncludeUnknownGroup()
If the unknown group should be included or not in the final rendered document or not.- Since:
- 0.3.0
-
getUnknownGroupLocalization
String getUnknownGroupLocalization()
Returns the title for the unknown group.- Since:
- 0.4.0
-
isIncludeEnvFormat
boolean isIncludeEnvFormat()
If the properties should be converted to their environment variable representation to have a quicker way to copy and paste them.- Since:
- 0.4.0
-
isIncludeGenerationDate
boolean isIncludeGenerationDate()
If the generation date should be rendered into the document or not.- Since:
- 0.4.0
-
isRemoveEmptyGroups
boolean isRemoveEmptyGroups()
If empty groups must be removed from the final document or not.- Since:
- 0.4.0
-
getLocale
String getLocale()
Returns the set locale.- Since:
- 0.4.0
-
-