com.atlassian.jira.help

Interface HelpUrlBuilder

All Known Implementing Classes:

MockHelpUrlBuilder, SimpleHelpUrlBuilder

@NotThreadSafe
public interface HelpUrlBuilder

Builder for creating HelpUrl instances.

Since:

v6.2.4

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HelpUrlBuilder.Factory

Method Summary

Modifier and Type	Method and Description
HelpUrlBuilder	alt(String alt) Set the HelpUrl.getAlt() of the generated HelpUrl.
HelpUrl	build() Generate the HelpUrl associated with this builder.
HelpUrlBuilder	copy() Creates an independent copy of the current state of the builder.
HelpUrlBuilder	description(String description) Set the HelpUrl.getDescription() of the generated HelpUrl.
HelpUrlBuilder	key(String key) Set the HelpUrl.getKey()} of the generated HelpUrl.
HelpUrlBuilder	local(boolean local) Set the HelpUrl.isLocal() of the generated HelpUrl.
HelpUrlBuilder	title(String title) Set the HelpUrl.getTitle() of the generated HelpUrl.
HelpUrlBuilder	url(String url) Set the URL of the generated HelpUrl.

Method Detail

key

HelpUrlBuilder key(String key)

Set the HelpUrl.getKey()} of the generated HelpUrl.

Parameters:

key - the key to set.

Returns:

this object so that the builder may be chained.

alt

HelpUrlBuilder alt(String alt)

Set the HelpUrl.getAlt() of the generated HelpUrl.

Parameters:

alt - the alternate text for the URL.

Returns:

this object so that the builder may be chained.

description

HelpUrlBuilder description(String description)

Set the HelpUrl.getDescription() of the generated HelpUrl.

Parameters:

description - the description for the URL.

Returns:

this object so that the builder may be chained.

title

HelpUrlBuilder title(String title)

Set the HelpUrl.getTitle() of the generated HelpUrl.

Parameters:

title - the title for the URL.

Returns:

this object so that the builder may be chained.

url

HelpUrlBuilder url(String url)

Set the URL of the generated HelpUrl.

Parameters:

url - the URL for the generated HelpUrl.

Returns:

this object so that the builder may be chained.

local

HelpUrlBuilder local(boolean local)

Set the HelpUrl.isLocal() of the generated HelpUrl.

Parameters:

local - if the generated HelpUrl is local or not.

Returns:

this object so that the builder may be chained.

copy

HelpUrlBuilder copy()

Creates an independent copy of the current state of the builder.

Returns:

an independent copy of the current builder.

build

HelpUrl build()

Generate the HelpUrl associated with this builder.