com.atlassian.jira.help

Interface HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder

All Known Implementing Classes:

DefaultHelpUrlsParserBuilderFactory.DefaultHelpUrlsParserBuilder, MockHelpUrlsParserBuilder

Enclosing interface:

HelpUrlsParserBuilderFactory

public static interface HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder

Method Summary

Modifier and Type	Method and Description
HelpUrlsParserBuilderFactory.HelpUrlsParserBuilder	applicationHelpSpace(com.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.

Method Detail

defaultUrl

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

Set the default url for parser.

Parameters:

url - default url address

title - default url title

Returns:

this instance for chaining

applicationHelpSpace

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

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.

Parameters:

applicationHelpSpace - space for application help

Returns:

this instance for chaining

build

@Nonnull
HelpUrlsParser build()

Create new parser instance.

Returns:

new HelpUrlsParser instance.