Package com.github.cukedoctor.converter

Class CukedoctorConverterImpl

java.lang.Object

com.github.cukedoctor.converter.CukedoctorConverterImpl

All Implemented Interfaces:

CukedoctorConverter

public class CukedoctorConverterImpl
extends Object
implements CukedoctorConverter

Created by pestano on 02/06/15.

Constructor Summary

Constructors

Constructor	Description
CukedoctorConverterImpl(List<Feature> features, DocumentAttributes attrs)
CukedoctorConverterImpl(List<Feature> features, DocumentAttributes attrs, CukedoctorConfig cukedoctorConfig)
CukedoctorConverterImpl(List<Feature> features, DocumentAttributes attrs, CukedoctorConfig cukedoctorConfig, CukedoctorDocumentBuilder docBuilder)

Method Summary

Modifier and Type	Method	Description
CukedoctorConverter	addCustomCss()
CukedoctorConverter	addCustomPdfTheme()
String	getDocumentation()
String	getDocumentationTitle()
DocumentAttributes	getDocumentAttributes()
List<Feature>	getFeatures()
String	getFilename()
CukedoctorConverter	renderAttributes()
String	renderDocumentation()
CukedoctorConverter	renderFeatures()
CukedoctorConverter	renderFeatures(List<Feature> features)
CukedoctorConverter	renderSummary()
CukedoctorConverter	saveDocumentation()	Saves the documentation into disk using CukedoctorConverter.getFilename() as name (also path).
CukedoctorConverter	setFilename(String filename)	set output file name without extension (should always be .adoc or other asciidoc compatible extensions) If no filename is set then Documentation title (first H1 section) will be used as filename (underline will be used to remove spaces) The filename is used mainly for asciidoc docinfo creation.

Methods inherited from class java.lang.Object

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

Constructor Detail

CukedoctorConverterImpl

public CukedoctorConverterImpl(List<Feature> features,
                               DocumentAttributes attrs)

CukedoctorConverterImpl

public CukedoctorConverterImpl(List<Feature> features,
                               DocumentAttributes attrs,
                               CukedoctorConfig cukedoctorConfig)

CukedoctorConverterImpl

public CukedoctorConverterImpl(List<Feature> features,
                               DocumentAttributes attrs,
                               CukedoctorConfig cukedoctorConfig,
                               CukedoctorDocumentBuilder docBuilder)

Method Detail

getDocumentAttributes

public DocumentAttributes getDocumentAttributes()

Specified by:

getDocumentAttributes in interface CukedoctorConverter

getFeatures

public List<Feature> getFeatures()

Specified by:

getFeatures in interface CukedoctorConverter

getDocumentation

public String getDocumentation()

Specified by:

getDocumentation in interface CukedoctorConverter

renderDocumentation

public String renderDocumentation()

Specified by:

renderDocumentation in interface CukedoctorConverter

Returns:

a String representation of generated documentation

getDocumentationTitle

public String getDocumentationTitle()

Specified by:

getDocumentationTitle in interface CukedoctorConverter

renderAttributes

public CukedoctorConverter renderAttributes()

Specified by:

renderAttributes in interface CukedoctorConverter

Returns:

underlying Converter instance

addCustomPdfTheme

public CukedoctorConverter addCustomPdfTheme()

Specified by:

addCustomPdfTheme in interface CukedoctorConverter

addCustomCss

public CukedoctorConverter addCustomCss()

Specified by:

addCustomCss in interface CukedoctorConverter

renderSummary

public CukedoctorConverter renderSummary()

Specified by:

renderSummary in interface CukedoctorConverter

Returns:

underlying Converter instance

renderFeatures

public CukedoctorConverter renderFeatures(List<Feature> features)

Specified by:

renderFeatures in interface CukedoctorConverter

Parameters:

features - the features to render

Returns:

underlying Converter instance

renderFeatures

public CukedoctorConverter renderFeatures()

Specified by:

renderFeatures in interface CukedoctorConverter

Returns:

underlying Converter instance

setFilename

public CukedoctorConverter setFilename(String filename)

Description copied from interface: CukedoctorConverter

set output file name without extension (should always be .adoc or other asciidoc compatible extensions) If no filename is set then Documentation title (first H1 section) will be used as filename (underline will be used to remove spaces) The filename is used mainly for asciidoc docinfo creation.

Specified by:

setFilename in interface CukedoctorConverter

Parameters:

filename - name to be set

Returns:

underlying Converter instance

getFilename

public String getFilename()

Specified by:

getFilename in interface CukedoctorConverter

saveDocumentation

public CukedoctorConverter saveDocumentation()

Description copied from interface: CukedoctorConverter

Saves the documentation into disk using CukedoctorConverter.getFilename() as name (also path). Note that

Specified by:

saveDocumentation in interface CukedoctorConverter

Returns:

underlying Converter instance

See Also:

will be called and used as content to save the file.