Class DocumentationLink
- java.lang.Object
-
- com.atlassian.confluence.util.i18n.DocumentationLink
-
public final class DocumentationLink extends Object
A user interface documentation link consisting of a key.Typically, messages will be presented to the user by looking up their value in a properties file (or "bundle"), and applying
DocumentationBean.getLink(String)
to the value. However, this class does not stipulate how the values held by this object might be used.This class is immutable and thread-safe.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DocumentationLink
getInstance(String key)
Constructs and returns an instance of a documentation url with the given key.String
getKey()
Returns the key, used for looking up the documentation url in a localisation bundle.String
toString()
-
-
-
Method Detail
-
getInstance
public static DocumentationLink getInstance(String key)
Constructs and returns an instance of a documentation url with the given key.- Parameters:
key
- the i18n message key- Returns:
- a new immutable DocumentationUrl instance
-
getKey
public String getKey()
Returns the key, used for looking up the documentation url in a localisation bundle.
-
-