com.atlassian.jira.issue.search.parameters.lucene
Class StringParameter

java.lang.Object
  extended bycom.atlassian.jira.issue.search.parameters.AbstractSearchParameter
      extended bycom.atlassian.jira.issue.search.parameters.AbstractLuceneParameter
          extended bycom.atlassian.jira.issue.search.parameters.lucene.SingleFieldSingleValueLuceneParameter
              extended bycom.atlassian.jira.issue.search.parameters.lucene.StringParameter
All Implemented Interfaces:
LuceneParameter, SearchParameter
Direct Known Subclasses:
UserParameter

public class StringParameter
extends SingleFieldSingleValueLuceneParameter


Field Summary
protected  String xmlElementName
           
 
Fields inherited from class com.atlassian.jira.issue.search.parameters.AbstractSearchParameter
JIRA_ENCODING, log, values
 
Constructor Summary
StringParameter()
           
StringParameter(String name, String value)
           
StringParameter(String name, String xmlElementName, String value)
           
 
Method Summary
protected  String getQueryStringPrefix()
          Query parameter name, suitable for inclusion in URL.
protected  String getXmlElementName()
          For some parameters, the parameter name may not be a valid XML element name (eg, if it contains a ':' in the case of custom fields.
 void setXml(electric.xml.Element el)
          Initialise this search parameter using an XML element.
 
Methods inherited from class com.atlassian.jira.issue.search.parameters.lucene.SingleFieldSingleValueLuceneParameter
getQuery, getXml, isValid
 
Methods inherited from class com.atlassian.jira.issue.search.parameters.AbstractSearchParameter
addValue, clearValues, equals, getName, getQueryString, getValues, hashCode, setName, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.atlassian.jira.issue.search.SearchParameter
addValue, getName, getQueryString, getValues, setName
 

Field Detail

xmlElementName

protected String xmlElementName
Constructor Detail

StringParameter

public StringParameter()

StringParameter

public StringParameter(String name,
                       String value)

StringParameter

public StringParameter(String name,
                       String xmlElementName,
                       String value)
Method Detail

setXml

public void setXml(electric.xml.Element el)
Description copied from interface: SearchParameter
Initialise this search parameter using an XML element. Usual process is:
    SearchParameter param = new MySearchParameter();
    param.setXml(element);
 

Specified by:
setXml in interface SearchParameter
Overrides:
setXml in class AbstractSearchParameter

getQueryStringPrefix

protected String getQueryStringPrefix()
Description copied from class: AbstractSearchParameter
Query parameter name, suitable for inclusion in URL. Note that implementations of this method should ensure that the values that they return are URLEncoded, perhaps using the URLEncoder.encode(String) method.

Overrides:
getQueryStringPrefix in class AbstractSearchParameter

getXmlElementName

protected String getXmlElementName()
Description copied from class: SingleFieldSingleValueLuceneParameter
For some parameters, the parameter name may not be a valid XML element name (eg, if it contains a ':' in the case of custom fields. For those parameters, you can override the element name here).

Overrides:
getXmlElementName in class SingleFieldSingleValueLuceneParameter
Returns:
The element name to describe this parameter. By default, it returns the same as AbstractSearchParameter.getName()


Copyright © 2002-2006 Atlassian. All Rights Reserved.