Package com.atlassian.jira.help

Class InitialHelpUrlsParser

java.lang.Object

com.atlassian.jira.help.InitialHelpUrlsParser

All Implemented Interfaces:

HelpUrlsParser

public class InitialHelpUrlsParser
extends Object

This is the actual HelpUrlsParser in core container. It provides an DefaultHelpUrlsParser instance with an initial onDemand that does a runtime check to determine how to process .ondemand properties.

Since:

v6.2.4

Constructor Summary

Constructors

Constructor	Description
InitialHelpUrlsParser(BuildUtilsInfo buildUtilsInfo, LocalHelpUrls localUrls)

Method Summary

Modifier and Type	Method	Description
HelpUrls	parse(Map<String,String> properties)	Parse the passed properties and return an equivalent HelpUrls instance.
HelpUrls	parse(Map<String,String> userProperties, Map<String,String> adminProperties)	Parse two passed maps with user and admin properties and return an equivalent HelpUrls instance.
HelpUrls	parse(Properties properties)	Parse the passed properties and return an equivalent HelpUrls instance.
HelpUrls	parse(Properties externalProperties, Properties internalProperties)	Parse the passed properties and return an equivalent HelpUrls instance.

Methods inherited from class java.lang.Object

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

Constructor Details

InitialHelpUrlsParser

public InitialHelpUrlsParser(BuildUtilsInfo buildUtilsInfo,
 LocalHelpUrls localUrls)

Method Details

parse

@Nonnull
public HelpUrls parse(@Nonnull
 Properties properties)

Description copied from interface: HelpUrlsParser

Parse the passed properties and return an equivalent HelpUrls instance.

Specified by:

parse in interface HelpUrlsParser

Parameters:

properties - the properties to parse.

Returns:

the HelpUrls representation of the passed properties.

parse

@Nonnull
public HelpUrls parse(@Nonnull
 Properties externalProperties,
 @Nonnull
 Properties internalProperties)

Description copied from interface: HelpUrlsParser

Parse the passed properties and return an equivalent HelpUrls instance.

This method should not be called by plugins as the format of internalProperties is not documented and is subject to change.

Specified by:

parse in interface HelpUrlsParser

Parameters:

externalProperties - the properties to parse.

internalProperties - the internal properties to parse. These properties follow a different format to the that documented on this interface and should only be used by JIRA internally.

Returns:

the HelpUrls representation of the passed properties.

parse

@Nonnull
public HelpUrls parse(@Nonnull
 Map<String,String> properties)

Description copied from interface: HelpUrlsParser

Parse the passed properties and return an equivalent HelpUrls instance.

Specified by:

parse in interface HelpUrlsParser

Parameters:

properties - the properties to parse.

Returns:

the HelpUrls representation of the passed properties.

parse

@Nonnull
public HelpUrls parse(@Nonnull
 Map<String,String> userProperties,
 @Nonnull
 Map<String,String> adminProperties)

Description copied from interface: HelpUrlsParser

Parse two passed maps with user and admin properties and return an equivalent HelpUrls instance. Default url will be read from the first map. Any other entries existing in both maps will be overwritten by entries from second (admin properties) map.

Specified by:

parse in interface HelpUrlsParser

Parameters:

userProperties - map containing user properties

adminProperties - map containing admin properties

Returns:

the HelpUrls representation of the passed properties.