org.apache.flink.configuration.description

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 the Description.

Method Summary

Modifier and Type	Method and Description
void	format(Formatter formatter) Transforms itself into String representation using given format.
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.

Methods inherited from class java.lang.Object

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

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 to

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

Transforms itself into String representation using given format.

Parameters:

formatter - formatter to use.