Module org.commonmark.ext.gfm.tables

Package org.commonmark.ext.gfm.tables

Class TablesExtension

java.lang.Object

org.commonmark.ext.gfm.tables.TablesExtension

All Implemented Interfaces:

Extension, Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, MarkdownRenderer.MarkdownRendererExtension, TextContentRenderer.TextContentRendererExtension

public class TablesExtension
extends Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, TextContentRenderer.TextContentRendererExtension, MarkdownRenderer.MarkdownRendererExtension

Extension for GFM tables using "|" pipes (GitHub Flavored Markdown).

Create it with create() and then configure it on the builders (Parser.Builder.extensions(Iterable), HtmlRenderer.Builder.extensions(Iterable)).

The parsed tables are turned into TableBlock blocks.

See Also:

• Tables (extension) in GitHub Flavored Markdown Spec

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TablesExtension.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_CELLS	The default limit for the maximum number of cells, see TablesExtension.Builder.maxCells(Integer).
private final Integer	maxCells

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TablesExtension(TablesExtension.Builder builder)

Method Summary

Modifier and Type	Method	Description
static TablesExtension.Builder	builder()
static Extension	create()
void	extend(Parser.Builder parserBuilder)
void	extend(HtmlRenderer.Builder rendererBuilder)
void	extend(MarkdownRenderer.Builder rendererBuilder)	Extend Markdown rendering, usually by registering custom node renderers using MarkdownRenderer.Builder.nodeRendererFactory(org.commonmark.renderer.markdown.MarkdownNodeRendererFactory).
void	extend(TextContentRenderer.Builder rendererBuilder)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MAX_CELLS

public static final int DEFAULT_MAX_CELLS

The default limit for the maximum number of cells, see TablesExtension.Builder.maxCells(Integer).

See Also:

• Constant Field Values

maxCells

private final Integer maxCells

Constructor Details

TablesExtension

private TablesExtension(TablesExtension.Builder builder)

Method Details

create

public static Extension create()

builder

public static TablesExtension.Builder builder()

Returns:

a builder to configure the behavior of the extension.

extend

public void extend(Parser.Builder parserBuilder)

Specified by:

extend in interface Parser.ParserExtension

extend

public void extend(HtmlRenderer.Builder rendererBuilder)

Specified by:

extend in interface HtmlRenderer.HtmlRendererExtension

extend

public void extend(TextContentRenderer.Builder rendererBuilder)

Specified by:

extend in interface TextContentRenderer.TextContentRendererExtension

extend

public void extend(MarkdownRenderer.Builder rendererBuilder)

Description copied from interface: MarkdownRenderer.MarkdownRendererExtension

Extend Markdown rendering, usually by registering custom node renderers using MarkdownRenderer.Builder.nodeRendererFactory(org.commonmark.renderer.markdown.MarkdownNodeRendererFactory).

Specified by:

extend in interface MarkdownRenderer.MarkdownRendererExtension

Parameters:

rendererBuilder - the renderer builder to extend