Package org.apache.flink.configuration.description

Class Formatter

java.lang.Object

org.apache.flink.configuration.description.Formatter

@PublicEvolving
public abstract class Formatter
extends Object

Allows providing multiple formatters for the description. E.g. Html formatter, Markdown formatter etc.

Constructor Summary

Constructors

Constructor	Description
Formatter()

Method Summary

Modifier and Type	Method	Description
String	format(Description description)	Formats the description into a String using format specific tags.
void	format(org.apache.flink.configuration.description.LineBreakElement element)
void	format(org.apache.flink.configuration.description.LinkElement element)
void	format(org.apache.flink.configuration.description.ListElement element)
void	format(TextElement element)
protected abstract void	formatLineBreak(StringBuilder state)
protected abstract void	formatLink(StringBuilder state, String link, String description)
protected abstract void	formatList(StringBuilder state, String[] entries)
protected abstract void	formatText(StringBuilder state, String format, String[] elements, EnumSet<TextElement.TextStyle> styles)
protected abstract Formatter	newInstance()

Methods inherited from class java.lang.Object

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

Constructor Details

Formatter

public Formatter()

Method Details

format

public String format(Description description)

Formats the description into a String using format specific tags.

Parameters:

description - description to be formatted

Returns:

string representation of the description

format

public void format(org.apache.flink.configuration.description.LinkElement element)

format

public void format(TextElement element)

format

public void format(org.apache.flink.configuration.description.LineBreakElement element)

format

public void format(org.apache.flink.configuration.description.ListElement element)

formatLink

protected abstract void formatLink(StringBuilder state,
 String link,
 String description)

formatLineBreak

protected abstract void formatLineBreak(StringBuilder state)

formatText

protected abstract void formatText(StringBuilder state,
 String format,
 String[] elements,
 EnumSet<TextElement.TextStyle> styles)

formatList

protected abstract void formatList(StringBuilder state,
 String[] entries)

newInstance

protected abstract Formatter newInstance()