Package com.atlassian.greenhopper.service.issue.callback

Class SprintAndProjectsCallback

java.lang.Object

com.atlassian.greenhopper.service.issue.callback.AbstractIssueDataCallback

com.atlassian.greenhopper.service.issue.callback.SprintAndProjectsCallback

All Implemented Interfaces:

IssueDataCallback

public class SprintAndProjectsCallback
extends AbstractIssueDataCallback

Collects sprints and associated project ids

Field Summary

Fields inherited from class com.atlassian.greenhopper.service.issue.callback.AbstractIssueDataCallback

fields

Constructor Summary

Constructors

Constructor	Description
SprintAndProjectsCallback(com.atlassian.jira.issue.fields.CustomField sprintCustomField)

Method Summary

Modifier and Type	Method	Description
void	fieldData(Long issueId, String issueKey, String fieldName, String data)	This callback is being called for every issue that matches the query.
Set<String>	getFields()	see DocumentConstants for possible values.
Map<String,Set<String>>	getSprintToProjects()	Get the sprint ids mapped to a set of project ids
void	issueComplete(Long issueId, String issueKey, io.atlassian.fugue.Option<org.apache.lucene.document.Document> issueDoc)	Called when all fieldData was returned for a single issue.

Methods inherited from class com.atlassian.greenhopper.service.issue.callback.AbstractIssueDataCallback

requiresIssueDoc

Methods inherited from class java.lang.Object

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

Constructor Details

SprintAndProjectsCallback

public SprintAndProjectsCallback(com.atlassian.jira.issue.fields.CustomField sprintCustomField)

Method Details

getFields

public Set<String> getFields()

Description copied from interface: IssueDataCallback

see DocumentConstants for possible values. These are the issue fields that we want to read from the Lucene index.

Specified by:

getFields in interface IssueDataCallback

Overrides:

getFields in class AbstractIssueDataCallback

fieldData

public void fieldData(Long issueId,
 String issueKey,
 String fieldName,
 String data)

Description copied from interface: IssueDataCallback

This callback is being called for every issue that matches the query. For memory efficiency, try to avoid buffering all results in memory but rather stream them to the target object, like a REST template.

Specified by:

fieldData in interface IssueDataCallback

Overrides:

fieldData in class AbstractIssueDataCallback

fieldName - : The name of the field that this value belongs to. One of the fields specified in getFields(). See DocumentConstants for possible values.

data - : The raw Lucene data for the given field. Can be null.

issueComplete

public void issueComplete(Long issueId,
 String issueKey,
 io.atlassian.fugue.Option<org.apache.lucene.document.Document> issueDoc)

Description copied from interface: IssueDataCallback

Called when all fieldData was returned for a single issue.

Specified by:

issueComplete in interface IssueDataCallback

Overrides:

issueComplete in class AbstractIssueDataCallback

Parameters:

issueId - is the issue id

issueKey - is the issue key

issueDoc - is an optional Lucene issue document

getSprintToProjects

public Map<String,Set<String>> getSprintToProjects()

Get the sprint ids mapped to a set of project ids