org.apache.flink.configuration.description

Class TextElement

java.lang.Object

org.apache.flink.configuration.description.TextElement

All Implemented Interfaces:

BlockElement, InlineElement

@PublicEvolving
public class TextElement
extends Object
implements BlockElement, InlineElement

Represents a text block in the Description.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextElement.TextStyle Styles that can be applied to TextElement e.g. code, bold etc.

Method Summary

Modifier and Type	Method and Description
static TextElement	code(String text) Creates a block of text formatted as code.
void	format(Formatter formatter) Transforms itself into String representation using given format.
List<InlineElement>	getElements()
String	getFormat()
EnumSet<TextElement.TextStyle>	getStyles()
static TextElement	text(String text) Creates a simple block of text.
static TextElement	text(String format, InlineElement... elements) Creates a block of text with placeholders ("%s") that will be replaced with proper string representation of given InlineElement.
static InlineElement	wrap(InlineElement... elements) Wraps a list of InlineElements into a single TextElement.

Methods inherited from class java.lang.Object

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

Method Detail

text

public static TextElement text(String format,
                               InlineElement... elements)

Creates a block of text with placeholders ("%s") that will be replaced with proper string representation of given InlineElement. For example:

text("This is a text with a link %s", link("https://somepage", "to here"))

Parameters:

format - text with placeholders for elements

elements - elements to be put in the text

Returns:

block of text

text

public static TextElement text(String text)

Creates a simple block of text.

Parameters:

text - a simple block of text

Returns:

block of text

wrap

public static InlineElement wrap(InlineElement... elements)

Wraps a list of InlineElements into a single TextElement.

code

public static TextElement code(String text)

Creates a block of text formatted as code.

Parameters:

text - a block of text that will be formatted as code

Returns:

block of text formatted as code

getFormat

public String getFormat()

getElements

public List<InlineElement> getElements()

getStyles

public EnumSet<TextElement.TextStyle> getStyles()

format

public void format(Formatter formatter)

Transforms itself into String representation using given format.

Parameters:

formatter - formatter to use.