java.lang.Object
- org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization

All Implemented Interfaces:

Serializable, TemplateCustomization

Direct Known Subclasses:

AsciiDocTemplateCustomization, HtmlTemplateCustomization, MarkdownTemplateCustomization, XmlTemplateCustomization
```
public abstract class AbstractTemplateCustomization
extends Object
implements TemplateCustomization, Serializable
```
Class represents a template customization object.

Since:

0.2.0

Author:

nandorholozsnyak

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected boolean`	`headerEnabled`	If the header should be enabled or not.
`protected boolean`	`includeEnvFormat`	If the properties should be converted to their environment variable representation to have a quicker way to copy and paste them.
`protected boolean`	`includeGenerationDate`	If the generation date should be rendered into the document or not.
`protected boolean`	`includeUnknownGroup`	If the 'Unknown group' should be included or not.
`protected String`	`locale`	Locale to be used during the i18n process.
`protected boolean`	`removeEmptyGroups`	If empty groups must be removed from the final document or not.
`protected boolean`	`tableOfContentsEnabled`	Should the "Table of Contents" enabled or not.
`protected String`	`unknownGroupLocalization`	Returns the title for the unknown group.

Constructor Summary

Constructors
Constructor Description

AbstractTemplateCustomization()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`String`	`getLocale()`	Returns the set locale.
`String`	`getTocTitle()`	Returns the 'Table of Contents' section title.
`String`	`getUnknownGroupLocalization()`	Returns the title for the unknown group.
`int`	`hashCode()`
`boolean`	`isHeaderEnabled()`
`boolean`	`isIncludeEnvFormat()`	If the properties should be converted to their environment variable representation to have a quicker way to copy and paste them.
`boolean`	`isIncludeGenerationDate()`	If the generation date should be rendered into the document or not.
`boolean`	`isIncludeUnknownGroup()`	If the unknown group should be included or not in the final rendered document or not.
`boolean`	`isRemoveEmptyGroups()`	If empty groups must be removed from the final document or not.
`boolean`	`isTableOfContentsEnabled()`
`void`	`setHeaderEnabled(boolean headerEnabled)`
`void`	`setIncludeEnvFormat(boolean includeEnvFormat)`
`void`	`setIncludeGenerationDate(boolean includeGenerationDate)`
`void`	`setIncludeUnknownGroup(boolean includeUnknownGroup)`
`void`	`setLocale(String locale)`
`void`	`setRemoveEmptyGroups(boolean removeEmptyGroups)`
`void`	`setTableOfContentsEnabled(boolean tableOfContentsEnabled)`
`void`	`setTocTitle(String tocTitle)`
`void`	`setUnknownGroupLocalization(String unknownGroupLocalization)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - headerEnabled
```
protected boolean headerEnabled
```
    If the header should be enabled or not.
    
    Since:
    
    0.2.0
  - tableOfContentsEnabled
```
protected boolean tableOfContentsEnabled
```
    Should the "Table of Contents" enabled or not.
    
    Since:
    
    0.2.0
  - includeUnknownGroup
```
protected boolean includeUnknownGroup
```
    If the 'Unknown group' should be included or not.
    
    Since:
    
    0.3.0
  - unknownGroupLocalization
```
protected String unknownGroupLocalization
```
    Returns the title for the unknown group.
    
    Since:
    
    0.4.0
  - includeEnvFormat
```
protected boolean includeEnvFormat
```
    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
  - includeGenerationDate
```
protected boolean includeGenerationDate
```
    If the generation date should be rendered into the document or not.
    
    Since:
    
    0.4.0
  - removeEmptyGroups
```
protected boolean removeEmptyGroups
```
    If empty groups must be removed from the final document or not.
    
    Since:
    
    0.4.0
  - locale
```
protected String locale
```
    Locale to be used during the i18n process.
    
    Since:
    
    0.4.0
- Constructor Detail
  - AbstractTemplateCustomization
```
public AbstractTemplateCustomization()
```
- Method Detail
  - getTocTitle
```
public String getTocTitle()
```
    Description copied from interface: TemplateCustomization
    
    Returns the 'Table of Contents' section title.
    
    Specified by:
    
    getTocTitle in interface TemplateCustomization
  - setTocTitle
```
public void setTocTitle(String tocTitle)
```
  - isHeaderEnabled
```
public boolean isHeaderEnabled()
```
  - setHeaderEnabled
```
public void setHeaderEnabled(boolean headerEnabled)
```
  - isTableOfContentsEnabled
```
public boolean isTableOfContentsEnabled()
```
  - setTableOfContentsEnabled
```
public void setTableOfContentsEnabled(boolean tableOfContentsEnabled)
```
  - isIncludeUnknownGroup
```
public boolean isIncludeUnknownGroup()
```
    Description copied from interface: TemplateCustomization
    
    If the unknown group should be included or not in the final rendered document or not.
    
    Specified by:
    
    isIncludeUnknownGroup in interface TemplateCustomization
  - setIncludeUnknownGroup
```
public void setIncludeUnknownGroup(boolean includeUnknownGroup)
```
  - isIncludeEnvFormat
```
public boolean isIncludeEnvFormat()
```
    Description copied from interface: TemplateCustomization
    
    If the properties should be converted to their environment variable representation to have a quicker way to copy and paste them.
    
    Specified by:
    
    isIncludeEnvFormat in interface TemplateCustomization
  - setIncludeEnvFormat
```
public void setIncludeEnvFormat(boolean includeEnvFormat)
```
  - isIncludeGenerationDate
```
public boolean isIncludeGenerationDate()
```
    Description copied from interface: TemplateCustomization
    
    If the generation date should be rendered into the document or not.
    
    Specified by:
    
    isIncludeGenerationDate in interface TemplateCustomization
  - setIncludeGenerationDate
```
public void setIncludeGenerationDate(boolean includeGenerationDate)
```
  - isRemoveEmptyGroups
```
public boolean isRemoveEmptyGroups()
```
    Description copied from interface: TemplateCustomization
    
    If empty groups must be removed from the final document or not.
    
    Specified by:
    
    isRemoveEmptyGroups in interface TemplateCustomization
  - setRemoveEmptyGroups
```
public void setRemoveEmptyGroups(boolean removeEmptyGroups)
```
  - getLocale
```
public String getLocale()
```
    Description copied from interface: TemplateCustomization
    
    Returns the set locale.
    
    Specified by:
    
    getLocale in interface TemplateCustomization
  - setLocale
```
public void setLocale(String locale)
```
  - getUnknownGroupLocalization
```
public String getUnknownGroupLocalization()
```
    Description copied from interface: TemplateCustomization
    
    Returns the title for the unknown group.
    
    Specified by:
    
    getUnknownGroupLocalization in interface TemplateCustomization
  - setUnknownGroupLocalization
```
public void setUnknownGroupLocalization(String unknownGroupLocalization)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class AbstractTemplateCustomization

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

headerEnabled

tableOfContentsEnabled

includeUnknownGroup

unknownGroupLocalization

includeEnvFormat

includeGenerationDate

removeEmptyGroups

locale

Constructor Detail

AbstractTemplateCustomization

Method Detail

getTocTitle

setTocTitle

isHeaderEnabled

setHeaderEnabled

isTableOfContentsEnabled

setTableOfContentsEnabled

isIncludeUnknownGroup

setIncludeUnknownGroup

isIncludeEnvFormat

setIncludeEnvFormat

isIncludeGenerationDate

setIncludeGenerationDate

isRemoveEmptyGroups

setRemoveEmptyGroups

getLocale

setLocale

getUnknownGroupLocalization

setUnknownGroupLocalization

equals

hashCode