Package com.atlassian.bamboo.feature.discovery

Class FeatureDiscoveryData.Link

java.lang.Object

com.atlassian.bamboo.feature.discovery.FeatureDiscoveryData.Link

Enclosing class:

FeatureDiscoveryData

public static class FeatureDiscoveryData.Link
extends Object

Constructor Summary

Constructors

Constructor	Description
Link(@NotNull FeatureDiscoveryData.LinkType type, @NotNull String url, @Nullable FeatureDiscoveryData.Condition condition)

Method Summary

Modifier and Type	Method	Description
@Nullable FeatureDiscoveryData.Condition	getCondition()	A condition which must be met to display this link.
@NotNull FeatureDiscoveryData.LinkType	getType()	Type of the link.
@NotNull String	getUrl()	URL of the link.

Methods inherited from class java.lang.Object

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

Constructor Detail

Link

public Link(@NotNull
            @NotNull FeatureDiscoveryData.LinkType type,
            @NotNull
            @NotNull String url,
            @Nullable
            @Nullable FeatureDiscoveryData.Condition condition)

Method Detail

getType

@NotNull
public @NotNull FeatureDiscoveryData.LinkType getType()

Type of the link.

getUrl

@NotNull
public @NotNull String getUrl()

URL of the link. Must be one of the following:

1. an absolute URL to an external page
2. a relative URL to a Bamboo page
3. a key of a documentation page which will form a valid URL through DocumentationLinkProvider

Examples:

1. https://docs.atlassian.com/bamboo-specs-docs/
2. /admin/viewSystemNotifications.action
3. plan.triggers.howtheywork

getCondition

@Nullable
public @Nullable FeatureDiscoveryData.Condition getCondition()

A condition which must be met to display this link.