Package org.rodnansol.core.generator.template.customization

Class AbstractTemplateCustomization

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 ContentCustomization	contentCustomization	Field storing customization options for the content template.
protected boolean	headerEnabled	If the header should be enabled or not.
protected boolean	includeEnvFormat	Deprecated, for removal: This API element is subject to removal in a future version.
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 TemplateMode	templateMode	Controls the template mode.
protected String	tocTitle	Table of Contents title.
protected String	unknownGroupLocalization	Returns the title for the unknown group.

Constructor Summary

Constructors

Constructor	Description
AbstractTemplateCustomization()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ContentCustomization	getContentCustomization()	Returns the template content customization.
String	getLocale()	Returns the set locale.
TemplateMode	getTemplateMode()	Controls if the template should be rendered in compact mode or not.
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	setContentCustomization(ContentCustomization contentCustomization)	Sets the template content customization.
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	setTemplateMode(TemplateMode templateMode)	Sets the template mode.
void	setTocTitle(String tocTitle)
void	setUnknownGroupLocalization(String unknownGroupLocalization)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

tocTitle

protected String tocTitle

Table of Contents title.

Since:

0.4.0

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

@Deprecated(forRemoval=true,
            since="0.6.0")
protected boolean includeEnvFormat

Deprecated, for removal: This API element is subject to removal in a future version.

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

contentCustomization

protected ContentCustomization contentCustomization

Field storing customization options for the content template.

Since:

0.6.0

templateMode

protected TemplateMode templateMode

Controls the template mode.

By default, the mode is STANDARD to provide backward compatibility.

Since:

0.6.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)

getContentCustomization

@NonNull
public ContentCustomization getContentCustomization()

Description copied from interface: TemplateCustomization

Returns the template content customization.

Specified by:

getContentCustomization in interface TemplateCustomization

setContentCustomization

public void setContentCustomization(@NonNull
                                    ContentCustomization contentCustomization)

Description copied from interface: TemplateCustomization

Sets the template content customization.

Specified by:

setContentCustomization in interface TemplateCustomization

getTemplateMode

public TemplateMode getTemplateMode()

Description copied from interface: TemplateCustomization

Controls if the template should be rendered in compact mode or not.

By default, for backward compatibility the compact mode is turned off.

Specified by:

getTemplateMode in interface TemplateCustomization

setTemplateMode

public void setTemplateMode(TemplateMode templateMode)

Description copied from interface: TemplateCustomization

Sets the template mode.

Specified by:

setTemplateMode in interface TemplateCustomization

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object