com.atlassian.jira.help

Class DefaultHelpUrlsParserBuilderFactory.DefaultHelpUrlsParserBuilder

java.lang.Object

com.atlassian.jira.help.DefaultHelpUrlsParserBuilderFactory.DefaultHelpUrlsParserBuilder

All Implemented Interfaces:

HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder

Enclosing class:

DefaultHelpUrlsParserBuilderFactory

public class DefaultHelpUrlsParserBuilderFactory.DefaultHelpUrlsParserBuilder
extends Object
implements HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder

Method Summary

Modifier and Type	Method and Description
HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder	applicationHelpSpace(io.atlassian.fugue.Option<String> applicationHelpSpace) Set the target space that will be used to replace application help space placeholder in parsed help urls.
HelpUrlsParser	build() Create new parser instance.
HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder	defaultUrl(String url, String title) Set the default url for parser.

Methods inherited from class java.lang.Object

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

Method Detail

defaultUrl

@Nonnull
public HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder defaultUrl(@Nonnull
                                                                              String url,
                                                                              String title)

Description copied from interface: HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder

Set the default url for parser.

Specified by:

defaultUrl in interface HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder

Parameters:

url - default url address

title - default url title

Returns:

this instance for chaining

applicationHelpSpace

@Nonnull
public HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder applicationHelpSpace(@Nonnull
                                                                                        io.atlassian.fugue.Option<String> applicationHelpSpace)

Description copied from interface: HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder

Set the target space that will be used to replace application help space placeholder in parsed help urls. If not set the replacement will not occur which matches the behaviour of injected HelpUrlsParser.

Specified by:

applicationHelpSpace in interface HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder

Parameters:

applicationHelpSpace - space for application help

Returns:

this instance for chaining

build

@Nonnull
public HelpUrlsParser build()

Description copied from interface: HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder

Create new parser instance.

Specified by:

build in interface HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder

Returns:

new HelpUrlsParser instance.