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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CukedoctorConverteraddCustomCss()CukedoctorConverteraddCustomPdfTheme()StringgetDocumentation()StringgetDocumentationTitle()DocumentAttributesgetDocumentAttributes()List<Feature>getFeatures()StringgetFilename()CukedoctorConverterrenderAttributes()StringrenderDocumentation()CukedoctorConverterrenderFeatures()CukedoctorConverterrenderFeatures(List<Feature> features)CukedoctorConverterrenderSummary()CukedoctorConvertersaveDocumentation()Saves the documentation into disk usingCukedoctorConverter.getFilename()as name (also path).CukedoctorConvertersetFilename(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.
-
-
-
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:
getDocumentAttributesin interfaceCukedoctorConverter
-
getFeatures
public List<Feature> getFeatures()
- Specified by:
getFeaturesin interfaceCukedoctorConverter
-
getDocumentation
public String getDocumentation()
- Specified by:
getDocumentationin interfaceCukedoctorConverter
-
renderDocumentation
public String renderDocumentation()
- Specified by:
renderDocumentationin interfaceCukedoctorConverter- Returns:
- a String representation of generated documentation
-
getDocumentationTitle
public String getDocumentationTitle()
- Specified by:
getDocumentationTitlein interfaceCukedoctorConverter
-
renderAttributes
public CukedoctorConverter renderAttributes()
- Specified by:
renderAttributesin interfaceCukedoctorConverter- Returns:
- underlying Converter instance
-
addCustomPdfTheme
public CukedoctorConverter addCustomPdfTheme()
- Specified by:
addCustomPdfThemein interfaceCukedoctorConverter
-
addCustomCss
public CukedoctorConverter addCustomCss()
- Specified by:
addCustomCssin interfaceCukedoctorConverter
-
renderSummary
public CukedoctorConverter renderSummary()
- Specified by:
renderSummaryin interfaceCukedoctorConverter- Returns:
- underlying Converter instance
-
renderFeatures
public CukedoctorConverter renderFeatures(List<Feature> features)
- Specified by:
renderFeaturesin interfaceCukedoctorConverter- Parameters:
features- the features to render- Returns:
- underlying Converter instance
-
renderFeatures
public CukedoctorConverter renderFeatures()
- Specified by:
renderFeaturesin interfaceCukedoctorConverter- Returns:
- underlying Converter instance
-
setFilename
public CukedoctorConverter setFilename(String filename)
Description copied from interface:CukedoctorConverterset 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:
setFilenamein interfaceCukedoctorConverter- Parameters:
filename- name to be set- Returns:
- underlying Converter instance
-
getFilename
public String getFilename()
- Specified by:
getFilenamein interfaceCukedoctorConverter
-
saveDocumentation
public CukedoctorConverter saveDocumentation()
Description copied from interface:CukedoctorConverterSaves the documentation into disk usingCukedoctorConverter.getFilename()as name (also path). Note that- Specified by:
saveDocumentationin interfaceCukedoctorConverter- Returns:
- underlying Converter instance
- See Also:
will be called and used as content to save the file.
-
-