com.atlassian.jira.jql.util
Interface JqlIssueKeySupport

All Known Implementing Classes:
JqlIssueKeySupportImpl

@InjectableComponent
public interface JqlIssueKeySupport

Provide JQL with some helper functions when dealing with Issue Keys.

Since:
v4.0

Method Summary
 boolean isValidIssueKey(String issueKey)
          Determines is the passed issue key is valid for JIRA.
 long parseKeyNum(String issueKey)
          Return the numeric part of the issue key.
 String parseProjectKey(String issueKey)
          Return the project key part of the issue key.
 

Method Detail

isValidIssueKey

boolean isValidIssueKey(String issueKey)
Determines is the passed issue key is valid for JIRA. It does *NOT* determine if the issue actually exists within JIRA.

Parameters:
issueKey - the issue key to validate. Null will be considered an invalid key.
Returns:
true if the passed key is valid or false otherwise.

parseKeyNum

long parseKeyNum(String issueKey)
Return the numeric part of the issue key. Assumes that the passed key is valid. The method will return -1 on a parsing error, however, this cannot be used to determine if a key is valid as some invalid keys may parse correctly. The isValidIssueKey(String) method can be used to determine if a key is invalid or not.

Parameters:
issueKey - the issue key to parse. A null key will return -1.
Returns:
the numeric part of the key. Will return -1 to indicate a parsing error.

parseProjectKey

String parseProjectKey(String issueKey)
Return the project key part of the issue key. Assumes that the passed key is valid. The method will return null on a parsing error, however, this cannot be used to determine if a key is valid as some invalid keys may parrse correctly. The isValidIssueKey(String) method can be used to determine if a key is invalid or not.

Parameters:
issueKey - the issue key to parse. A null key will return null.
Returns:
the project key part of the issue key, or null on a parsing error.


Copyright © 2002-2009 Atlassian. All Rights Reserved.