com.credibledoc.substitution.doc.module.substitution.markdown.table

Class TableService

java.lang.Object

com.credibledoc.substitution.doc.module.substitution.markdown.table.TableService

@Service
public class TableService
extends Object

This service generates markdown tables, see the createMarkdownTableFromEnum(Table.Builder, Class) method.

Author:

Kyrylo Semenko

Field Summary

Fields

Modifier and Type	Field and Description
private static String	EMPTY_STRING
private static String	NEW_LINE
private static String	ONE_SPACE

Constructor Summary

Constructors

Constructor and Description
TableService()

Method Summary

Modifier and Type	Method and Description
String	createMarkdownTableFromEnum(net.steppschuh.markdowngenerator.table.Table.Builder tableBuilder, Class<?> enumClass) Generates content of a table with two columns from Enum fields.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_STRING

private static final String EMPTY_STRING

See Also:

Constant Field Values

ONE_SPACE

private static final String ONE_SPACE

See Also:

Constant Field Values

NEW_LINE

private static final String NEW_LINE

See Also:

Constant Field Values

Constructor Detail

TableService

@Inject
public TableService()

Method Detail

createMarkdownTableFromEnum

public String createMarkdownTableFromEnum(net.steppschuh.markdowngenerator.table.Table.Builder tableBuilder,
                                          Class<?> enumClass)

Generates content of a table with two columns from Enum fields.

Example of usage:

     public String generate() {

         Table.Builder tableBuilder = new Table.Builder()

                 .addRow("Application name", "Description");



         return tableService.createMarkdownTableFromEnum(tableBuilder, TacticHolder.class);

     }

 

Parameters:

tableBuilder - en empty table with header

enumClass - the data source

Returns:

the first column with enum fields and a second column with fields JavaDoc