public interface

ConditionBuilder

com.atlassian.jira.jql.builder.ConditionBuilder

Class Overview

An interface that is used to build JQL conditions for a particular JQL field in a fluent programming style. It is created and returned from the factory methods on the JqlClauseBuilder. For example, the affectedVersion() method creates a new ConditionBuilder for the affectes version system field in JIRA.

The object's main job is to specify the operator for the JQL current condition being generated. The value of the JQL condition can be specified when the operator is specified, or later using the ValueBuilder. For example, the JQL clause affectedVersion = "1.2" can be generated using JqlQueryBuilder.affectedVersion().eq("1.2").build() or JqlQueryBuilder.affectedVersion().eq().string("1.2").build().

Generally, it is not possible to passs nulls, empty collections, empty arrays, collections that contain nulls, or arrays that contain nulls to the method on the interface. Any exceptions to these argument conditions are documented on the method concern. Passing a method a bad argument will result in a IllegalArgumentException.

JQL values are of two types String and Long. For fields that are resolvable by both Id's and Names (e.g. projects, versions, issue types, components, options etc), the order of resolution depends on the value type. If the JQL value type is long, JIRA will first attempt to find the domain object by Id, if that fails, it will attempt to find the domain object by name with the string value of the long. If the JQL value type is a String, JIRA will first try to find the domain object by name, if that fails AND the string can be parsed into a number, JIRA attempts to find the domain object by id with that number.

Summary

Public Methods
ValueBuilder eq()
Make the operator for the JQL condition equals.
JqlClauseBuilder eq(Operand operand)
Create the JQL condition with the equals operator and the passed value.
JqlClauseBuilder eq(Date date)
Create the JQL condition with the equals operator and the passed date.
JqlClauseBuilder eq(String value)
Create the JQL condition with the equals operator and the passed value.
JqlClauseBuilder eq(Long value)
Create the JQL condition with the equals operator and the passed value.
JqlClauseBuilder eqEmpty()
Create the JQL condition with the equals operator and the EMPTY value.
JqlClauseBuilder eqFunc(String funcName, String... args)
Create the JQL condition with the equals operator and the passed function.
JqlClauseBuilder eqFunc(String funcName, Collection<String> args)
Create the JQL condition with the equals operator and the passed function.
JqlClauseBuilder eqFunc(String funcName)
Create the JQL condition with the equals operator and the passed function.
ValueBuilder gt()
Make the operator for the JQL condition greater than.
JqlClauseBuilder gt(Date date)
Create the JQL condition with the greater than operator and the passed date.
JqlClauseBuilder gt(Long value)
Create the JQL condition with the greater than operator and the passed value.
JqlClauseBuilder gt(Operand operand)
Create the JQL condition with the greater than operator and the passed value.
JqlClauseBuilder gt(String value)
Create the JQL condition with the greater than operator and the passed value.
JqlClauseBuilder gtEq(Date date)
Create the JQL condition with the greater than or equals operator and the passed date.
ValueBuilder gtEq()
Make the operator for the JQL condition greater than equals.
JqlClauseBuilder gtEq(Long value)
Create the JQL condition with the greater than equals operator and the passed value.
JqlClauseBuilder gtEq(Operand operand)
Create the JQL condition with the greater than equals operator and the passed value.
JqlClauseBuilder gtEq(String value)
Create the JQL condition with the greater than equals operator and the passed value.
JqlClauseBuilder gtEqFunc(String funcName)
Create the JQL condition with the greater than equals operator and the passed function.
JqlClauseBuilder gtEqFunc(String funcName, Collection<String> args)
Create the JQL condition with the greater than equals operator and the passed function.
JqlClauseBuilder gtEqFunc(String funcName, String... args)
Create the JQL condition with the greater than equals operator and the passed function.
JqlClauseBuilder gtFunc(String funcName, Collection<String> args)
Create the JQL condition with the ">" operator and the passed function.
JqlClauseBuilder gtFunc(String funcName)
Create the JQL condition with the ">" operator and the passed function.
JqlClauseBuilder gtFunc(String funcName, String... args)
Create the JQL condition with the ">" operator and the passed function.
JqlClauseBuilder in(Long... values)
Create the JQL condition with the in operator and the passed values.
JqlClauseBuilder in(String... values)
Create the JQL condition with the in operator and the passed values.
JqlClauseBuilder in(Date... dates)
Create the JQL condition with the in operator and the passed values.
JqlClauseBuilder in(Operand... operands)
Create the JQL condition with the in operator and the passed values.
ValueBuilder in()
Make the operator for the JQL condition in.
JqlClauseBuilder inDates(Collection<Date> dates)
Create the JQL condition with the in operator and the passed values.
JqlClauseBuilder inFunc(String funcName)
Create the JQL condition with the "in" operator and the passed function.
JqlClauseBuilder inFunc(String funcName, String... args)
Create the JQL condition with the "in" operator and the passed function.
JqlClauseBuilder inFunc(String funcName, Collection<String> args)
Create the JQL condition with the "in" operator and the passed function.
JqlClauseBuilder inNumbers(Collection<Long> values)
Create the JQL condition with the in operator and the passed values.
JqlClauseBuilder inOperands(Collection<Operand> operands)
Create the JQL condition with the in operator and the passed values.
JqlClauseBuilder inStrings(Collection<String> values)
Create the JQL condition with the in operator and the passed values.
ValueBuilder is()
Make the operator for the JQL condition is.
JqlClauseBuilder isEmpty()
Create the JQL condition with the is operator and the EMPTY value.
ValueBuilder isNot()
Make the operator for the JQL condition is not.
JqlClauseBuilder isNotEmpty()
Create the JQL condition with the is not operator and the EMPTY value.
JqlClauseBuilder like(Operand operand)
Create the JQL condition with the like operator and the passed value.
JqlClauseBuilder like(String value)
Create the JQL condition with the like operator and the passed value.
JqlClauseBuilder like(Long value)
Create the JQL condition with the like operator and the passed value.
ValueBuilder like()
Make the operator for the JQL condition like.
JqlClauseBuilder like(Date date)
Create the JQL condition with the like operator and the passed date.
JqlClauseBuilder likeFunc(String funcName)
Create the JQL condition with the like operator and the passed function.
JqlClauseBuilder likeFunc(String funcName, Collection<String> args)
Create the JQL condition with the like operator and the passed function.
JqlClauseBuilder likeFunc(String funcName, String... args)
Create the JQL condition with the like operator and the passed function.
ValueBuilder lt()
Make the operator for the JQL condition less than.
JqlClauseBuilder lt(Operand operand)
Create the JQL condition with the less than operator and the passed value.
JqlClauseBuilder lt(String value)
Create the JQL condition with the less than operator and the passed value.
JqlClauseBuilder lt(Long value)
Create the JQL condition with the less than operator and the passed value.
JqlClauseBuilder lt(Date date)
Create the JQL condition with the less than operator and the passed date.
JqlClauseBuilder ltEq(Date date)
Create the JQL condition with the less than or equals operator and the passed date.
JqlClauseBuilder ltEq(Long value)
Create the JQL condition with the less than equals operator and the passed value.
JqlClauseBuilder ltEq(Operand operand)
Create the JQL condition with the less than equals operator and the passed value.
ValueBuilder ltEq()
Make the operator for the JQL condition less than equals.
JqlClauseBuilder ltEq(String value)
Create the JQL condition with the less than equals operator and the passed value.
JqlClauseBuilder ltEqFunc(String funcName)
Create the JQL condition with the "<=" operator and the passed function.
JqlClauseBuilder ltEqFunc(String funcName, String... args)
Create the JQL condition with the "<=" operator and the passed function.
JqlClauseBuilder ltEqFunc(String funcName, Collection<String> args)
Create the JQL condition with the "<=" operator and the passed function.
JqlClauseBuilder ltFunc(String funcName, String... args)
Create the JQL condition with the "<" operator and the passed function.
JqlClauseBuilder ltFunc(String funcName, Collection<String> args)
Create the JQL condition with the "<" operator and the passed function.
JqlClauseBuilder ltFunc(String funcName)
Create the JQL condition with the "<" operator and the passed function.
JqlClauseBuilder notEq(Date date)
Create the JQL condition with the not equals operator and the passed date.
JqlClauseBuilder notEq(String value)
Create the JQL condition with the not equals operator and the passed value.
JqlClauseBuilder notEq(Long value)
Create the JQL condition with the not equals operator and the passed value.
ValueBuilder notEq()
Make the operator for the JQL condition not equals.
JqlClauseBuilder notEq(Operand operand)
Create the JQL condition with the not equals operator and the passed value.
JqlClauseBuilder notEqEmpty()
Create the JQL condition with the not equals operator and the EMPTY value.
JqlClauseBuilder notEqFunc(String funcName, String... args)
Create the JQL condition with the not equals operator and the passed function.
JqlClauseBuilder notEqFunc(String funcName, Collection<String> args)
Create the JQL condition with the not equals operator and the passed function.
JqlClauseBuilder notEqFunc(String funcName)
Create the JQL condition with the not equals operator and the passed function.
ValueBuilder notIn()
Make the operator for the JQL condition not in.
JqlClauseBuilder notIn(Date... dates)
Create the JQL condition with the not in operator and the passed values.
JqlClauseBuilder notIn(String... values)
Create the JQL condition with the not in operator and the passed values.
JqlClauseBuilder notIn(Operand... operands)
Create the JQL condition with the not in operator and the passed values.
JqlClauseBuilder notIn(Long... values)
Create the JQL condition with the not in operator and the passed values.
JqlClauseBuilder notInDates(Collection<Date> dates)
Create the JQL condition with the in operator and the passed values.
JqlClauseBuilder notInFunc(String funcName)
Create the JQL condition with the "not in" operator and the passed function.
JqlClauseBuilder notInFunc(String funcName, String... args)
Create the JQL condition with the "not in" operator and the passed function.
JqlClauseBuilder notInFunc(String funcName, Collection<String> args)
Create the JQL condition with the "not in" operator and the passed function.
JqlClauseBuilder notInNumbers(Collection<Long> values)
Create the JQL condition with the not in operator and the passed values.
JqlClauseBuilder notInOperands(Collection<Operand> operands)
Create the JQL condition with the not in operator and the passed values.
JqlClauseBuilder notInStrings(Collection<String> values)
Create the JQL condition with the not in operator and the passed values.
JqlClauseBuilder notLike(Long value)
Create the JQL condition with the not like operator and the passed value.
JqlClauseBuilder notLike(Date date)
Create the JQL condition with the not like operator and the passed date.
JqlClauseBuilder notLike(Operand operand)
Create the JQL condition with the not like operator and the passed value.
JqlClauseBuilder notLike(String value)
Create the JQL condition with the not like operator and the passed value.
ValueBuilder notLike()
Make the operator for the JQL condition not like.
JqlClauseBuilder notLikeFunc(String funcName, Collection<String> args)
Create the JQL condition with the not like operator and the passed function.
JqlClauseBuilder notLikeFunc(String funcName, String... args)
Create the JQL condition with the not like operator and the passed function.
JqlClauseBuilder notLikeFunc(String funcName)
Create the JQL condition with the not like operator and the passed function.
JqlClauseBuilder range(String start, String end)
Add a condition range condition to the current query for the passed values.
JqlClauseBuilder range(Long start, Long end)
Add a condition range condition to the current query for the passed values.
JqlClauseBuilder range(Operand start, Operand end)
Add a condition range condition to the current query for the passed values.
JqlClauseBuilder range(Date start, Date end)
Add a condition range condition to the current query for the passed dates.

Public Methods

public ValueBuilder eq ()

Make the operator for the JQL condition equals. The value of the condition can be specified using the returned ValueBuilder.

Returns
  • a builder that can be used to specify the value of the condition.

public JqlClauseBuilder eq (Operand operand)

Create the JQL condition with the equals operator and the passed value. It essentially creates the JQL condition name = operand.

Parameters
operand the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder eq (Date date)

Create the JQL condition with the equals operator and the passed date. It essentially creates the JQL condition name = date.

Parameters
date the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder eq (String value)

Create the JQL condition with the equals operator and the passed value. It essentially creates the JQL condition name = "str".

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder eq (Long value)

Create the JQL condition with the equals operator and the passed value. It essentially creates the JQL condition name = value.

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder eqEmpty ()

Create the JQL condition with the equals operator and the EMPTY value. It essentially creates the JQL condition name = EMPTY.

Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder eqFunc (String funcName, String... args)

Create the JQL condition with the equals operator and the passed function. It essentially creates the JQL condition name = funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder eqFunc (String funcName, Collection<String> args)

Create the JQL condition with the equals operator and the passed function. It essentially creates the JQL condition name = funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder eqFunc (String funcName)

Create the JQL condition with the equals operator and the passed function. It essentially creates the JQL condition name = funcName().

Parameters
funcName the name of the function in the new condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public ValueBuilder gt ()

Make the operator for the JQL condition greater than. The value of the condition can be specified using the returned ValueBuilder.

Returns
  • a builder that can be used to specify the value of the condition.

public JqlClauseBuilder gt (Date date)

Create the JQL condition with the greater than operator and the passed date. It essentially creates the JQL condition name &gt; date.

Parameters
date the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder gt (Long value)

Create the JQL condition with the greater than operator and the passed value. It essentially creates the JQL condition name &gt; value.

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder gt (Operand operand)

Create the JQL condition with the greater than operator and the passed value. It essentially creates the JQL condition name &gt; operand.

Parameters
operand the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder gt (String value)

Create the JQL condition with the greater than operator and the passed value. It essentially creates the JQL condition name &gt; "str".

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder gtEq (Date date)

Create the JQL condition with the greater than or equals operator and the passed date. It essentially creates the JQL condition name &gt;= date.

Parameters
date the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public ValueBuilder gtEq ()

Make the operator for the JQL condition greater than equals. The value of the condition can be specified using the returned ValueBuilder.

Returns
  • a builder that can be used to specify the value of the condition.

public JqlClauseBuilder gtEq (Long value)

Create the JQL condition with the greater than equals operator and the passed value. It essentially creates the JQL condition name &gt;= value.

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder gtEq (Operand operand)

Create the JQL condition with the greater than equals operator and the passed value. It essentially creates the JQL condition name &gt;= operand.

Parameters
operand the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder gtEq (String value)

Create the JQL condition with the greater than equals operator and the passed value. It essentially creates the JQL condition name &gt;= "str".

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder gtEqFunc (String funcName)

Create the JQL condition with the greater than equals operator and the passed function. It essentially creates the JQL condition name &gt;= funcName().

Parameters
funcName the name of the function in the new condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder gtEqFunc (String funcName, Collection<String> args)

Create the JQL condition with the greater than equals operator and the passed function. It essentially creates the JQL condition name &gt;= funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder gtEqFunc (String funcName, String... args)

Create the JQL condition with the greater than equals operator and the passed function. It essentially creates the JQL condition name &gt;= funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder gtFunc (String funcName, Collection<String> args)

Create the JQL condition with the ">" operator and the passed function. It essentially creates the JQL condition name &gt; funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder gtFunc (String funcName)

Create the JQL condition with the ">" operator and the passed function. It essentially creates the JQL condition name &gt; funcName().

Parameters
funcName the name of the function in the new condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder gtFunc (String funcName, String... args)

Create the JQL condition with the ">" operator and the passed function. It essentially creates the JQL condition name &gt; funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder in (Long... values)

Create the JQL condition with the in operator and the passed values. It essentially creates the JQL condition name IN (values).

Parameters
values the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder in (String... values)

Create the JQL condition with the in operator and the passed values. It essentially creates the JQL condition name IN (values).

Parameters
values the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder in (Date... dates)

Create the JQL condition with the in operator and the passed values. It essentially creates the JQL condition name IN (dates).

Parameters
dates the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder in (Operand... operands)

Create the JQL condition with the in operator and the passed values. It essentially creates the JQL condition name IN (operands).

Parameters
operands the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public ValueBuilder in ()

Make the operator for the JQL condition in. The values of the condition can be specified using the returned ValueBuilder.

Returns
  • a builder that can be used to specify the value of the condition.

public JqlClauseBuilder inDates (Collection<Date> dates)

Create the JQL condition with the in operator and the passed values. It essentially creates the JQL condition name IN (dates).

Parameters
dates the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder inFunc (String funcName)

Create the JQL condition with the "in" operator and the passed function. It essentially creates the JQL condition name in funcName().

Parameters
funcName the name of the function in the new condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder inFunc (String funcName, String... args)

Create the JQL condition with the "in" operator and the passed function. It essentially creates the JQL condition name in funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder inFunc (String funcName, Collection<String> args)

Create the JQL condition with the "in" operator and the passed function. It essentially creates the JQL condition name in funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder inNumbers (Collection<Long> values)

Create the JQL condition with the in operator and the passed values. It essentially creates the JQL condition name IN (values).

Parameters
values the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder inOperands (Collection<Operand> operands)

Create the JQL condition with the in operator and the passed values. It essentially creates the JQL condition name IN (operands).

Parameters
operands the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder inStrings (Collection<String> values)

Create the JQL condition with the in operator and the passed values. It essentially creates the JQL condition name IN (values).

Parameters
values the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public ValueBuilder is ()

Make the operator for the JQL condition is. The value of the condition can be specified using the returned ValueBuilder.

Returns
  • a builder that can be used to specify the value of the condition.

public JqlClauseBuilder isEmpty ()

Create the JQL condition with the is operator and the EMPTY value. It essentially creates the JQL condition name IS EMPTY.

Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public ValueBuilder isNot ()

Make the operator for the JQL condition is not. The value of the condition can be specified using the returned ValueBuilder.

Returns
  • a builder that can be used to specify the value of the condition.

public JqlClauseBuilder isNotEmpty ()

Create the JQL condition with the is not operator and the EMPTY value. It essentially creates the JQL condition name IS NOT EMPTY.

Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder like (Operand operand)

Create the JQL condition with the like operator and the passed value. It essentially creates the JQL condition name ~ operand.

Parameters
operand the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder like (String value)

Create the JQL condition with the like operator and the passed value. It essentially creates the JQL condition name ~ "str".

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder like (Long value)

Create the JQL condition with the like operator and the passed value. It essentially creates the JQL condition name ~ value.

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public ValueBuilder like ()

Make the operator for the JQL condition like. The value of the condition can be specified using the returned ValueBuilder.

Returns
  • a builder that can be used to specify the value of the condition.

public JqlClauseBuilder like (Date date)

Create the JQL condition with the like operator and the passed date. It essentially creates the JQL condition name ~ date.

Parameters
date the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder likeFunc (String funcName)

Create the JQL condition with the like operator and the passed function. It essentially creates the JQL condition name ~ funcName().

Parameters
funcName the name of the function in the new condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder likeFunc (String funcName, Collection<String> args)

Create the JQL condition with the like operator and the passed function. It essentially creates the JQL condition name != funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder likeFunc (String funcName, String... args)

Create the JQL condition with the like operator and the passed function. It essentially creates the JQL condition name ~ funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public ValueBuilder lt ()

Make the operator for the JQL condition less than. The value of the condition can be specified using the returned ValueBuilder.

Returns
  • a builder that can be used to specify the value of the condition.

public JqlClauseBuilder lt (Operand operand)

Create the JQL condition with the less than operator and the passed value. It essentially creates the JQL condition name &lt; operand.

Parameters
operand the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder lt (String value)

Create the JQL condition with the less than operator and the passed value. It essentially creates the JQL condition name &lt; "str".

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder lt (Long value)

Create the JQL condition with the less than operator and the passed value. It essentially creates the JQL condition name &lt; value.

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder lt (Date date)

Create the JQL condition with the less than operator and the passed date. It essentially creates the JQL condition name &lt; date.

Parameters
date the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder ltEq (Date date)

Create the JQL condition with the less than or equals operator and the passed date. It essentially creates the JQL condition name &lt;= date.

Parameters
date the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder ltEq (Long value)

Create the JQL condition with the less than equals operator and the passed value. It essentially creates the JQL condition name &lt;= value.

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder ltEq (Operand operand)

Create the JQL condition with the less than equals operator and the passed value. It essentially creates the JQL condition name &lt;= operand.

Parameters
operand the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public ValueBuilder ltEq ()

Make the operator for the JQL condition less than equals. The value of the condition can be specified using the returned ValueBuilder.

Returns
  • a builder that can be used to specify the value of the condition.

public JqlClauseBuilder ltEq (String value)

Create the JQL condition with the less than equals operator and the passed value. It essentially creates the JQL condition name &lt;= "str".

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder ltEqFunc (String funcName)

Create the JQL condition with the "<=" operator and the passed function. It essentially creates the JQL condition name &lt;= funcName().

Parameters
funcName the name of the function in the new condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder ltEqFunc (String funcName, String... args)

Create the JQL condition with the "<=" operator and the passed function. It essentially creates the JQL condition name &lt;= funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder ltEqFunc (String funcName, Collection<String> args)

Create the JQL condition with the "<=" operator and the passed function. It essentially creates the JQL condition name &lt;= funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder ltFunc (String funcName, String... args)

Create the JQL condition with the "<" operator and the passed function. It essentially creates the JQL condition name < funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder ltFunc (String funcName, Collection<String> args)

Create the JQL condition with the "<" operator and the passed function. It essentially creates the JQL condition name < funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder ltFunc (String funcName)

Create the JQL condition with the "<" operator and the passed function. It essentially creates the JQL condition name < funcName().

Parameters
funcName the name of the function in the new condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notEq (Date date)

Create the JQL condition with the not equals operator and the passed date. It essentially creates the JQL condition name != date.

Parameters
date the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notEq (String value)

Create the JQL condition with the not equals operator and the passed value. It essentially creates the JQL condition name != "str".

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notEq (Long value)

Create the JQL condition with the not equals operator and the passed value. It essentially creates the JQL condition name != value.

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public ValueBuilder notEq ()

Make the operator for the JQL condition not equals. The value of the condition can be specified using the returned ValueBuilder.

Returns
  • a builder that can be used to specify the value of the condition.

public JqlClauseBuilder notEq (Operand operand)

Create the JQL condition with the not equals operator and the passed value. It essentially creates the JQL condition name != operand.

Parameters
operand the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notEqEmpty ()

Create the JQL condition with the not equals operator and the EMPTY value. It essentially creates the JQL condition name != EMPTY.

Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notEqFunc (String funcName, String... args)

Create the JQL condition with the not equals operator and the passed function. It essentially creates the JQL condition name != funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notEqFunc (String funcName, Collection<String> args)

Create the JQL condition with the not equals operator and the passed function. It essentially creates the JQL condition name != funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notEqFunc (String funcName)

Create the JQL condition with the not equals operator and the passed function. It essentially creates the JQL condition name != funcName().

Parameters
funcName the name of the function in the new condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public ValueBuilder notIn ()

Make the operator for the JQL condition not in. The values of the condition can be specified using the returned ValueBuilder.

Returns
  • a builder that can be used to specify the value of the condition.

public JqlClauseBuilder notIn (Date... dates)

Create the JQL condition with the not in operator and the passed values. It essentially creates the JQL condition name NOT IN (dates).

Parameters
dates the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notIn (String... values)

Create the JQL condition with the not in operator and the passed values. It essentially creates the JQL condition name NOT IN (values).

Parameters
values the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notIn (Operand... operands)

Create the JQL condition with the not in operator and the passed values. It essentially creates the JQL condition name NOT IN (operands).

Parameters
operands the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notIn (Long... values)

Create the JQL condition with the not in operator and the passed values. It essentially creates the JQL condition name NOT IN (values).

Parameters
values the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notInDates (Collection<Date> dates)

Create the JQL condition with the in operator and the passed values. It essentially creates the JQL condition name NOT IN (dates).

Parameters
dates the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notInFunc (String funcName)

Create the JQL condition with the "not in" operator and the passed function. It essentially creates the JQL condition name not in funcName().

Parameters
funcName the name of the function in the new condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notInFunc (String funcName, String... args)

Create the JQL condition with the "not in" operator and the passed function. It essentially creates the JQL condition name not in funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notInFunc (String funcName, Collection<String> args)

Create the JQL condition with the "not in" operator and the passed function. It essentially creates the JQL condition name not in funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notInNumbers (Collection<Long> values)

Create the JQL condition with the not in operator and the passed values. It essentially creates the JQL condition name NOT IN (values).

Parameters
values the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notInOperands (Collection<Operand> operands)

Create the JQL condition with the not in operator and the passed values. It essentially creates the JQL condition name NOT IN (operands).

Parameters
operands the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notInStrings (Collection<String> values)

Create the JQL condition with the not in operator and the passed values. It essentially creates the JQL condition name NOT IN (values).

Parameters
values the values of the condition. Cannot be null, empty or contain any null value.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notLike (Long value)

Create the JQL condition with the not like operator and the passed value. It essentially creates the JQL condition name !~ value.

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notLike (Date date)

Create the JQL condition with the not like operator and the passed date. It essentially creates the JQL condition name !~ date.

Parameters
date the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notLike (Operand operand)

Create the JQL condition with the not like operator and the passed value. It essentially creates the JQL condition name !~ operand.

Parameters
operand the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notLike (String value)

Create the JQL condition with the not like operator and the passed value. It essentially creates the JQL condition name !~ "str".

Parameters
value the value of the condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public ValueBuilder notLike ()

Make the operator for the JQL condition not like. The value of the condition can be specified using the returned ValueBuilder.

Returns
  • a builder that can be used to specify the value of the condition.

public JqlClauseBuilder notLikeFunc (String funcName, Collection<String> args)

Create the JQL condition with the not like operator and the passed function. It essentially creates the JQL condition name !~ funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notLikeFunc (String funcName, String... args)

Create the JQL condition with the not like operator and the passed function. It essentially creates the JQL condition name !~ funcName(arg1, arg2, arg3, ... argN).

Parameters
funcName the name of the function in the new condition.
args the arguments for the function. Cannot be null or contain any null values.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder notLikeFunc (String funcName)

Create the JQL condition with the not like operator and the passed function. It essentially creates the JQL condition name !~ funcName().

Parameters
funcName the name of the function in the new condition. Cannot be null.
Returns
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.

public JqlClauseBuilder range (String start, String end)

Add a condition range condition to the current query for the passed values. This essentially adds the query clauseName &gt;= start AND clauseName &lt;= end to the query being built.

It is also possible to create an open interval by passing one of the arguments as null. Passing a non-null start with a null end will add the condition clauseName &gt;= start. Passing a non-null end with a null start will add the condition clauseName &lt;= end. Passing a null start and null end is illegal.

Parameters
start the value for the start of the range. May be null if end is not null.
end the value for the end of the range. May be null if start is not null.
Returns
  • a reference to the current builder.
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.
IllegalArgumentException if both start and end are null.

public JqlClauseBuilder range (Long start, Long end)

Add a condition range condition to the current query for the passed values. This essentially adds the query clauseName &gt;= start AND clauseName &lt;= end to the query being built.

It is also possible to create an open interval by passing one of the arguments as null. Passing a non-null start with a null end will add the condition clauseName &gt;= start. Passing a non-null end with a null start will add the condition clauseName &lt;= end. Passing a null start and null end is illegal.

Parameters
start the value for the start of the range. May be null if end is not null.
end the value for the end of the range. May be null if start is not null.
Returns
  • a reference to the current builder.
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.
IllegalArgumentException if both start and end are null.

public JqlClauseBuilder range (Operand start, Operand end)

Add a condition range condition to the current query for the passed values. This essentially adds the query clauseName &gt;= start AND clauseName &lt;= end to the query being built.

It is also possible to create an open interval by passing one of the arguments as null. Passing a non-null start with a null end will add the condition clauseName &gt;= start. Passing a non-null end with a null start will add the condition clauseName &lt;= end. Passing a null start and null end is illegal.

Parameters
start the value for the start of the range. May be null if end is not null.
end the value for the end of the range. May be null if start is not null.
Returns
  • a reference to the current builder.
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.
IllegalArgumentException if both start and end are null.

public JqlClauseBuilder range (Date start, Date end)

Add a condition range condition to the current query for the passed dates. This essentially adds the query clauseName &gt;= start AND clauseName &lt;= end to the query being built.

It is also possible to create an open interval by passing one of the arguments as null. Passing a non-null start with a null end will add the condition clauseName &gt;= start. Passing a non-null end with a null start will add the condition clauseName &lt;= end. Passing a null start and null end is illegal.

Parameters
start the date for the start of the range. May be null if end is not null.
end the date for the end of the range. May be null if start is not null.
Returns
  • a reference to the current builder.
Throws
IllegalStateException if it is not possible to add a JQL condition given the current state of the builder.
IllegalArgumentException if both start and end are null.