org.apache.maven.plugin.jira
Class JqlQueryBuilder

java.lang.Object
  org.apache.maven.plugin.jira.JqlQueryBuilder

All Implemented Interfaces:

JiraQueryBuilder

public class JqlQueryBuilder
extends Object
implements JiraQueryBuilder

Builder for a JIRA query using the JIRA query language. Only a limited set of JQL is supported.

Since:

2.8

Version:

$Id: JqlQueryBuilder.java 1579078 2014-03-18 22:44:41Z dennisl $

Author:

ton.swieb@finalist.com

Constructor Summary

JqlQueryBuilder(org.apache.maven.plugin.logging.Log log)

Method Summary

String	build()
JiraQueryBuilder	components(List<String> components)
JiraQueryBuilder	components(String components)
JiraQueryBuilder	filter(String filter)
JiraQueryBuilder	fixVersion(String fixVersion) When both fixVersion(String) and fixVersionIds(String) are used then you will probably end up with a JQL query that is valid, but returns nothing.
JiraQueryBuilder	fixVersionIds(List<String> fixVersionIds) Add a sequence of version IDs already in a list.
JiraQueryBuilder	fixVersionIds(String fixVersionIds) When both fixVersion(String) and fixVersionIds(String) are used then you will probably end up with a JQL query that is valid, but returns nothing.
org.apache.maven.plugin.logging.Log	getLog()
JiraQueryBuilder	priorityIds(List<String> priorityIds)
JiraQueryBuilder	priorityIds(String priorityIds)
JiraQueryBuilder	project(String project)
JiraQueryBuilder	resolutionIds(List<String> resolutionIds)
JiraQueryBuilder	resolutionIds(String resolutionIds)
JiraQueryBuilder	sortColumnNames(String sortColumnNames)
JiraQueryBuilder	statusIds(List<String> statusIds)
JiraQueryBuilder	statusIds(String statusIds)
JiraQueryBuilder	typeIds(List<String> typeIds)
JiraQueryBuilder	typeIds(String typeIds)
boolean	urlEncode()
JiraQueryBuilder	urlEncode(boolean doEncoding)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JqlQueryBuilder

public JqlQueryBuilder(org.apache.maven.plugin.logging.Log log)

Method Detail

build

public String build()

Specified by:

build in interface JiraQueryBuilder

components

public JiraQueryBuilder components(String components)

Specified by:

components in interface JiraQueryBuilder

components

public JiraQueryBuilder components(List<String> components)

Specified by:

components in interface JiraQueryBuilder

filter

public JiraQueryBuilder filter(String filter)

Specified by:

filter in interface JiraQueryBuilder

fixVersion

public JiraQueryBuilder fixVersion(String fixVersion)

When both fixVersion(String) and fixVersionIds(String) are used then you will probably end up with a JQL query that is valid, but returns nothing. Unless they both only reference the same fixVersion

Specified by:

fixVersion in interface JiraQueryBuilder

Parameters:

fixVersion - a single fix version

Returns:

fixVersionIds

public JiraQueryBuilder fixVersionIds(String fixVersionIds)

When both fixVersion(String) and fixVersionIds(String) are used then you will probably end up with a JQL query that is valid, but returns nothing. Unless they both only reference the same fixVersion

Specified by:

fixVersionIds in interface JiraQueryBuilder

Parameters:

fixVersionIds - a comma-separated list of version ids.

Returns:

fixVersionIds

public JiraQueryBuilder fixVersionIds(List<String> fixVersionIds)

Add a sequence of version IDs already in a list.

Specified by:

fixVersionIds in interface JiraQueryBuilder

Parameters:

fixVersionIds - the version ids.

Returns:

getLog

public org.apache.maven.plugin.logging.Log getLog()

Specified by:

getLog in interface JiraQueryBuilder

priorityIds

public JiraQueryBuilder priorityIds(String priorityIds)

Specified by:

priorityIds in interface JiraQueryBuilder

priorityIds

public JiraQueryBuilder priorityIds(List<String> priorityIds)

Specified by:

priorityIds in interface JiraQueryBuilder

project

public JiraQueryBuilder project(String project)

Specified by:

project in interface JiraQueryBuilder

resolutionIds

public JiraQueryBuilder resolutionIds(String resolutionIds)

Specified by:

resolutionIds in interface JiraQueryBuilder

resolutionIds

public JiraQueryBuilder resolutionIds(List<String> resolutionIds)

Specified by:

resolutionIds in interface JiraQueryBuilder

sortColumnNames

public JiraQueryBuilder sortColumnNames(String sortColumnNames)

Specified by:

sortColumnNames in interface JiraQueryBuilder

statusIds

public JiraQueryBuilder statusIds(String statusIds)

Specified by:

statusIds in interface JiraQueryBuilder

statusIds

public JiraQueryBuilder statusIds(List<String> statusIds)

Specified by:

statusIds in interface JiraQueryBuilder

typeIds

public JiraQueryBuilder typeIds(String typeIds)

Specified by:

typeIds in interface JiraQueryBuilder

typeIds

public JiraQueryBuilder typeIds(List<String> typeIds)

Specified by:

typeIds in interface JiraQueryBuilder

urlEncode

public JiraQueryBuilder urlEncode(boolean doEncoding)

urlEncode

public boolean urlEncode()