Package com.atlassian.confluence.labels

Class CombinedLabel

java.lang.Object

com.atlassian.confluence.labels.CombinedLabel

All Implemented Interfaces:

DisplayableLabel

public class CombinedLabel
extends Object
implements DisplayableLabel

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
CombinedLabel(List<Label> labels)

Method Summary

Modifier and Type	Method	Description
String	getDisplayTitle()
String	getName()	Returns the label's name only.
String	getUrlPath()	Generates the url path for a label.
String	getUrlPath(String spaceKey)	Generates the url path for a label in the context of a given space i.e.
boolean	isRealTitleSafeForUrl()	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3 unused

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.labels.DisplayableLabel

getRealTitle

Field Details

ADD_SEPARATOR

public static final String ADD_SEPARATOR

See Also:

• Constant Field Values

Constructor Details

CombinedLabel

public CombinedLabel(List<Label> labels)

Method Details

isRealTitleSafeForUrl

@Deprecated(since="9.3",
            forRemoval=true)
public boolean isRealTitleSafeForUrl()

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3 unused

Description copied from interface: DisplayableLabel

Returns true if the label's title is safe to pass in the URL.

eg. my:foo is safe, perc% is not safe. chicken+cheese is safe in a "combined" label.

Specified by:

isRealTitleSafeForUrl in interface DisplayableLabel

Returns:

true if the label's title is safe to pass in the URL.

getName

public String getName()

Description copied from interface: DisplayableLabel

Returns the label's name only.

eg. label name for label my:foo is "foo".

Specified by:

getName in interface DisplayableLabel

getUrlPath

public String getUrlPath()

Description copied from interface: DisplayableLabel

Generates the url path for a label.

Specified by:

getUrlPath in interface DisplayableLabel

getUrlPath

public String getUrlPath(String spaceKey)

Description copied from interface: DisplayableLabel

Generates the url path for a label in the context of a given space i.e. the user is taken to a page that contains content for that space only.

If no space if provided, DisplayableLabel.getUrlPath() is called.

Specified by:

getUrlPath in interface DisplayableLabel

getDisplayTitle

public String getDisplayTitle()

Specified by:

getDisplayTitle in interface DisplayableLabel