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

java.lang.Object
  extended by com.atlassian.greenhopper.service.issue.callback.AbstractIssueDataCallback
All Implemented Interfaces:
IssueDataCallback
Direct Known Subclasses:
EpicLabelAndKeyByProjectCallback, EpicLabelAndKeyMatchingCallback, IssueAndParentKeyCallback, IssueIdCallback, IssueKeyCallback, IssueKeyWithClassicEpicLinkDataCallback, ProjectIssueDataCallback, ProjectsCallback, SprintAndIssueIdsCallback, SprintAndProjectsCallback, SprintIdCallback, StatusCountCallback, StatusProgressCallback

public abstract class AbstractIssueDataCallback
extends java.lang.Object
implements IssueDataCallback

Abstract implementation of a callback


Field Summary
protected  java.util.Set<java.lang.String> fields
           
 
Constructor Summary
AbstractIssueDataCallback()
           
AbstractIssueDataCallback(java.lang.String... fields)
           
 
Method Summary
 void fieldData(java.lang.Long issueId, java.lang.String issueKey, java.lang.String fieldName, java.lang.String data)
          This callback is being called for every issue that matches the query.
 java.util.Set<java.lang.String> getFields()
          see DocumentConstants for possible values.
 void issueComplete(java.lang.Long issueId, java.lang.String issueKey)
          Called when all fieldData was returned for a single issue.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fields

protected final java.util.Set<java.lang.String> fields
Constructor Detail

AbstractIssueDataCallback

public AbstractIssueDataCallback()

AbstractIssueDataCallback

public AbstractIssueDataCallback(java.lang.String... fields)
Method Detail

getFields

public java.util.Set<java.lang.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

fieldData

public void fieldData(java.lang.Long issueId,
                      java.lang.String issueKey,
                      java.lang.String fieldName,
                      java.lang.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
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(java.lang.Long issueId,
                          java.lang.String issueKey)
Description copied from interface: IssueDataCallback
Called when all fieldData was returned for a single issue.

Specified by:
issueComplete in interface IssueDataCallback


Copyright © 2007-2013 Atlassian. All Rights Reserved.