com.atlassian.confluence.util.i18n

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

Modifier and Type	Method and 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()

Methods inherited from class java.lang.Object

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

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.

toString

public String toString()

Overrides:

toString in class Object