Package com.atlassian.jira.help

Class SimpleHelpUrlBuilder

java.lang.Object

com.atlassian.jira.help.SimpleHelpUrlBuilder

All Implemented Interfaces:

HelpUrlBuilder

public class SimpleHelpUrlBuilder
extends Object

Since:

v6.2.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleHelpUrlBuilder.Factory

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

key

public final HelpUrlBuilder key(String key)

Description copied from interface: HelpUrlBuilder

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

Specified by:

key in interface HelpUrlBuilder

Parameters:

key - the key to set.

Returns:

this object so that the builder may be chained.

description

public final HelpUrlBuilder description(String description)

Description copied from interface: HelpUrlBuilder

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

Specified by:

description in interface HelpUrlBuilder

Parameters:

description - the description for the URL.

Returns:

this object so that the builder may be chained.

alt

public final HelpUrlBuilder alt(String alt)

Description copied from interface: HelpUrlBuilder

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

Specified by:

alt in interface HelpUrlBuilder

Parameters:

alt - the alternate text for the URL.

Returns:

this object so that the builder may be chained.

title

public final HelpUrlBuilder title(String title)

Description copied from interface: HelpUrlBuilder

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

Specified by:

title in interface HelpUrlBuilder

Parameters:

title - the title for the URL.

Returns:

this object so that the builder may be chained.

url

public final HelpUrlBuilder url(String url)

Description copied from interface: HelpUrlBuilder

Set the URL of the generated HelpUrl.

Specified by:

url in interface HelpUrlBuilder

Parameters:

url - the URL for the generated HelpUrl.

Returns:

this object so that the builder may be chained.

local

public final HelpUrlBuilder local(boolean local)

Description copied from interface: HelpUrlBuilder

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

Specified by:

local in interface HelpUrlBuilder

Parameters:

local - if the generated HelpUrl is local or not.

Returns:

this object so that the builder may be chained.

copy

public final HelpUrlBuilder copy()

Description copied from interface: HelpUrlBuilder

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

Specified by:

copy in interface HelpUrlBuilder

Returns:

an independent copy of the current builder.

build

public final HelpUrl build()

Description copied from interface: HelpUrlBuilder

Generate the HelpUrl associated with this builder.

Specified by:

build in interface HelpUrlBuilder