Package com.atlassian.jira.util

Class JiraKeyUtils

java.lang.Object
com.atlassian.jira.util.JiraKeyUtils
public class JiraKeyUtils extends Object

  • Field Details

  • Constructor Details

    • JiraKeyUtils

      public JiraKeyUtils()

  • Method Details

    • resetKeyMatcher

      public static void resetKeyMatcher()
      Resets the configuration of the key matcher so that it will re-read the ApplicationProperty that specifies how to find an issue key in a string. This must be called if the property for representing the key matching regular expression is changed at runtime.

    • validProjectKey

      public static boolean validProjectKey(String key)
      Validates the given project key and returns true if valid, false otherwise.
      Parameters:
      key - project key to validate
      Returns:
      True if the supplied project key is valid

    • isReservedKeyword

      public static boolean isReservedKeyword(String key)
      Check if the Project Key matches a list of reserved keywords - JRA-8051. For example, a folder named 'CON' cannot be created in WINDOWS as it is a reserved word.

      This check is only enabled for WINDOWS machines at present as this issue has only been reported in the WINDOWS environment.

      Parameters:
      key - project key
      Returns:
      true if reserved word, false otherwise

    • getProjectKeyFromIssueKey

      @Deprecated public static String getProjectKeyFromIssueKey(String key)
      Deprecated.
      Use IssueKey.from(String) instead. Since v6.1.
      Returns a project key of the project given issue belongs to.
      Parameters:
      key - issue key
      Returns:
      The project key from an issue key, or null if the key is invalid

    • getFastProjectKeyFromIssueKey

      @Deprecated public static String getFastProjectKeyFromIssueKey(String key)
      Deprecated.
      Use IssueKey.from(String) instead. Since v6.1.
      Same as getProjectKeyFromIssueKey(String) except that it does not check key validity
      Parameters:
      key - issue key
      Returns:
      The project key from an issue key, or null if the key is invalid

    • getFastCountFromKey

      @Deprecated public static long getFastCountFromKey(String key)
      Deprecated.
      Use IssueKey.from(String) instead. Since v6.1.
      Same as getCountFromKey(String) except that is does not check for key validity
      Parameters:
      key - issue key
      Returns:
      The issue count from an issue key, or -1 if the key is invalid

    • getCountFromKey

      @Deprecated public static long getCountFromKey(String key)
      Deprecated.
      Use IssueKey.from(String) instead. Since v6.1.
      Parameters:
      key - issue key
      Returns:
      The issue count from an issue key, or -1 if the key is invalid

    • validIssueKey

      public static boolean validIssueKey(String key)
      Validates the given issue key.
      Parameters:
      key - issue key
      Returns:
      True if the supplied issue key starts with a valid project key, and ends with a number

    • isKeyInString

      public static boolean isKeyInString(String issueKey, String body)
      Determines whether the provided key is part of the provided string
      Parameters:
      issueKey - issue key
      body - string to check
      Returns:
      true if the given key is in the body, false otherwise

    • isKeyInString

      public static boolean isKeyInString(String s)
      Determines whether any JIRA issue key is in the given string
      Parameters:
      s - string to check
      Returns:
      true if a key was found, false otherwise

    • linkBugKeys

      public static String linkBugKeys(String body)

    • getIssueKeysFromString

      public static List<String> getIssueKeysFromString(String body)

    • isPartOfUrl

      public static boolean isPartOfUrl(String body, int start)

    • getIssueKeyRegex

      public static String getIssueKeyRegex()

    • fastFormatIssueKey

      @Nullable public static String fastFormatIssueKey(@Nonnull String projectKey, @Nonnull Long issueNumber)

    • slowFormatIssueKey

      public static String slowFormatIssueKey(@Nonnull String projectKey, @Nonnull Long issueNumber)