@NotThreadSafe public interface

HelpUrlBuilder

com.atlassian.jira.help.HelpUrlBuilder
Known Indirect Subclasses

Class Overview

Builder for creating HelpUrl instances.

Summary

Nested Classes
interface HelpUrlBuilder.Factory  
Public Methods
HelpUrlBuilder alt(String alt)
Set the 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 key(String key)
Set the getKey()} of the generated HelpUrl.
HelpUrlBuilder local(boolean local)
Set the isLocal() of the generated HelpUrl.
HelpUrlBuilder title(String title)
Set the getTitle() of the generated HelpUrl.
HelpUrlBuilder url(String url)
Set the URL of the generated HelpUrl.

Public Methods

public HelpUrlBuilder alt (String alt)

Set the getAlt() of the generated HelpUrl.

Parameters
alt the alternate text for the URL.
Returns
  • this object so that the builder may be chained.

public HelpUrl build ()

Generate the HelpUrl associated with this builder.

public HelpUrlBuilder copy ()

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

Returns
  • an independent copy of the current builder.

public HelpUrlBuilder key (String key)

Set the getKey()} of the generated HelpUrl.

Parameters
key the key to set.
Returns
  • this object so that the builder may be chained.

public HelpUrlBuilder local (boolean local)

Set the 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.

public HelpUrlBuilder title (String title)

Set the getTitle() of the generated HelpUrl.

Parameters
title the title for the URL.
Returns
  • this object so that the builder may be chained.

public 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.