org.apache.paimon.options.description

类 TextElement

java.lang.Object

org.apache.paimon.options.description.TextElement

所有已实现的接口:

BlockElement, InlineElement

public class TextElement
extends Object
implements BlockElement, InlineElement

Represents a text block in the Description.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	TextElement.TextStyle Styles that can be applied to TextElement e.g. code, bold etc.

方法概要

限定符和类型	方法和说明
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.

从类继承的方法 java.lang.Object

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

方法详细资料

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"))

参数:

format - text with placeholders for elements

elements - elements to be put in the text

返回:

block of text

text

public static TextElement text(String text)

Creates a simple block of text.

参数:

text - a simple block of text

返回:

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.

参数:

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

返回:

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.

参数:

formatter - formatter to use.