Class LinkElement
- java.lang.Object
-
- org.apache.flink.configuration.description.LinkElement
-
- All Implemented Interfaces:
InlineElement
@PublicEvolving public class LinkElement extends Object implements InlineElement
Element that represents a link in theDescription
.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
format(Formatter formatter)
String
getLink()
String
getText()
static LinkElement
link(String link)
Creates a link with a given url.static LinkElement
link(String link, String text)
Creates a link with a given url and description.
-
-
-
Method Detail
-
link
public static LinkElement link(String link, String text)
Creates a link with a given url and description.- Parameters:
link
- address that this link should point totext
- a description for that link, that should be used in text- Returns:
- link representation
-
link
public static LinkElement link(String link)
Creates a link with a given url. This url will be used as a description for that link.- Parameters:
link
- address that this link should point to- Returns:
- link representation
-
getLink
public String getLink()
-
getText
public String getText()
-
format
public void format(Formatter formatter)
-
-