Package com.atlassian.jira.help

Class MockHelpUrlsParser

java.lang.Object
com.atlassian.jira.help.MockHelpUrlsParser
All Implemented Interfaces:
HelpUrlsParser
public class MockHelpUrlsParser extends Object implements HelpUrlsParser
Since:
v6.2.4

  • Constructor Details

    • MockHelpUrlsParser

      public MockHelpUrlsParser()

  • 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 MockHelpUrls 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(Map<String,String> userProperties, 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.

    • getDefault

      public HelpUrl getDefault()

    • registerOd

      public MockHelpUrlsParser registerOd(HelpUrl url)

    • register

      public MockHelpUrlsParser register(HelpUrl url)

    • createUrl

      public MockHelpUrl createUrl(String key, String url)

    • createUrlOd

      public MockHelpUrl createUrlOd(String key, String url)

    • getGeneratedUrl

      public HelpUrl getGeneratedUrl(HelpUrl url, String value)

    • getGeneratedDefault

      public HelpUrl getGeneratedDefault(String value)

    • getApplicationHelpSpace

      public io.atlassian.fugue.Option<String> getApplicationHelpSpace()

    • setApplicationHelpSpace

      public void setApplicationHelpSpace(io.atlassian.fugue.Option<String> applicationHelpSpace)

    • setDefaultUrl

      @Nonnull public HelpUrlsParser setDefaultUrl(String url, String title)

    • setOnDemand

      @Nonnull public HelpUrlsParser setOnDemand(boolean onDemand)