com.atlassian.jira.issue.search.parameters
Class AbstractSearchParameter

java.lang.Object
  extended bycom.atlassian.jira.issue.search.parameters.AbstractSearchParameter
All Implemented Interfaces:
SearchParameter
Direct Known Subclasses:
FilterParameter, LuceneParameter, OfbizParameter

public abstract class AbstractSearchParameter
extends java.lang.Object
implements SearchParameter


Field Summary
protected  org.apache.log4j.Category log
           
(package private)  java.lang.String name
           
(package private)  java.util.List values
           
 
Constructor Summary
AbstractSearchParameter()
           
AbstractSearchParameter(java.lang.String name)
           
 
Method Summary
 void addValue(java.lang.Object value)
           
protected  void clearValues()
           
 boolean equals(java.lang.Object o)
           
 java.lang.String getName()
           
 java.lang.String getQueryString()
           
protected  java.lang.String getQueryStringPrefix()
          Note that implementations of this method should ensure that the values that they return are URLEncoded, perhaps using the URLEncoder.encode(String) method.
 java.util.List getValues()
           
abstract  electric.xml.Element getXml()
          Return an XML representation of this search parameter
 int hashCode()
           
abstract  boolean isValid()
           
 void setName(java.lang.String name)
           
 void setXml(electric.xml.Element el)
          Initialise this search parameter using an XML element.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

log

protected final org.apache.log4j.Category log

name

java.lang.String name

values

java.util.List values
Constructor Detail

AbstractSearchParameter

public AbstractSearchParameter()

AbstractSearchParameter

public AbstractSearchParameter(java.lang.String name)
Method Detail

getXml

public abstract electric.xml.Element getXml()
Description copied from interface: SearchParameter
Return an XML representation of this search parameter

Specified by:
getXml in interface SearchParameter

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

isValid

public abstract boolean isValid()
Specified by:
isValid in interface SearchParameter

getQueryString

public java.lang.String getQueryString()
Specified by:
getQueryString in interface SearchParameter

getQueryStringPrefix

protected java.lang.String getQueryStringPrefix()
Note that implementations of this method should ensure that the values that they return are URLEncoded, perhaps using the URLEncoder.encode(String) method.

Returns:

addValue

public void addValue(java.lang.Object value)
Specified by:
addValue in interface SearchParameter

getValues

public java.util.List getValues()
Specified by:
getValues in interface SearchParameter

clearValues

protected void clearValues()

getName

public java.lang.String getName()
Specified by:
getName in interface SearchParameter

setName

public void setName(java.lang.String name)
Specified by:
setName in interface SearchParameter

equals

public boolean equals(java.lang.Object o)

hashCode

public int hashCode()

toString

public java.lang.String toString()


Copyright © 2002-2005 Atlassian. All Rights Reserved.