com.atlassian.jira.jql.operand

Class QueryLiteral

java.lang.Object

com.atlassian.jira.jql.operand.QueryLiteral

public class QueryLiteral
extends Object

Used to communicate literal values, Strings or Longs, as input into the Operands.

• Long values are typically used to represent ids or raw numerical values. For example, issue ids are represented using a Long.
• String values are typically used to represent raw string values or named values that need to be resolved into ids. For example, issue keys or project names are represented using a String.

When writing JqlFunctions that must return QueryLiterals, try to return the more specific QueryLiteral where possible, to avoid unnecessary resolving. "More specific" here means the form that is used by the index (if applicable), as this value can then be used directly when constructing index queries.

QueryLiterals contain an operand source, this is the Operand of the JQL that produced the QueryLiteral. For instance in the JQL query project = HSP the "HSP" QueryLiteral will have the operand source of a SingleValueOperand with value "HSP". Notably QueryLiterals produced by JqlFunctions must set the FunctionOperand as the operand source.

Since:

v4.0

Constructor Summary

Constructors

Constructor and Description
QueryLiteral()
QueryLiteral(Operand sourceOperand)
QueryLiteral(Operand sourceOperand, Long longValue)
QueryLiteral(Operand sourceOperand, String stringValue)

Method Summary

Modifier and Type	Method and Description
String	asString()
boolean	equals(Object o)
Long	getLongValue()
Operand	getSourceOperand()
String	getStringValue()
int	hashCode()
boolean	isEmpty()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryLiteral

public QueryLiteral()

QueryLiteral

public QueryLiteral(Operand sourceOperand)

QueryLiteral

public QueryLiteral(Operand sourceOperand,
                    Long longValue)

QueryLiteral

public QueryLiteral(Operand sourceOperand,
                    String stringValue)

Method Detail

getStringValue

public String getStringValue()

getLongValue

public Long getLongValue()

getSourceOperand

public Operand getSourceOperand()

isEmpty

public boolean isEmpty()

asString

public String asString()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object