com.atlassian.jira.issue.search.quicksearch
Class PrefixedSingleWordQuickSearchHandler

java.lang.Object
  extended by com.atlassian.jira.issue.search.quicksearch.SingleWordQuickSearchHandler
      extended by com.atlassian.jira.issue.search.quicksearch.PrefixedSingleWordQuickSearchHandler
All Implemented Interfaces:
QuickSearchHandler
Direct Known Subclasses:
ComponentQuickSearchHandler, ReporterQuickSearchHandler, VersionQuickSearchHandler

public abstract class PrefixedSingleWordQuickSearchHandler
extends SingleWordQuickSearchHandler

Convenient class for all quick search handlers that handle single words with a prefix.

Since:
v3.13

Constructor Summary
PrefixedSingleWordQuickSearchHandler()
           
 
Method Summary
protected abstract  String getPrefix()
          Gets the prefix this quick search handler handles
protected  Map handleWord(String word, QuickSearchResult searchResult)
          Hanldle a single word, and return a map of parameters
protected abstract  Map handleWordSuffix(String wordSuffix, QuickSearchResult searchResult)
          Handle the word suffix (original word without the prefix)
 
Methods inherited from class com.atlassian.jira.issue.search.quicksearch.SingleWordQuickSearchHandler
getByName, modifySearchResult
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PrefixedSingleWordQuickSearchHandler

public PrefixedSingleWordQuickSearchHandler()
Method Detail

handleWord

protected Map handleWord(String word,
                         QuickSearchResult searchResult)
Description copied from class: SingleWordQuickSearchHandler
Hanldle a single word, and return a map of parameters

Specified by:
handleWord in class SingleWordQuickSearchHandler
Parameters:
word - A single word - guaranteed to not be null
searchResult - The existing search result
Returns:
A Map of parameters that can be used as a URL.

getPrefix

protected abstract String getPrefix()
Gets the prefix this quick search handler handles

Returns:
handled prefix

handleWordSuffix

protected abstract Map handleWordSuffix(String wordSuffix,
                                        QuickSearchResult searchResult)
Handle the word suffix (original word without the prefix)

Parameters:
wordSuffix - the original word minus the prefix
searchResult - search result
Returns:
Map of search parameters


Copyright © 2002-2013 Atlassian. All Rights Reserved.