com.atlassian.jira.issue.comments.util
Class LuceneCommentIterator

java.lang.Object
  com.atlassian.jira.issue.comments.util.LuceneCommentIterator

All Implemented Interfaces:

CommentIterator, java.util.Iterator<Comment>

@NotThreadSafe
public final class LuceneCommentIterator
extends java.lang.Object
implements CommentIterator

This class iterates across a series of comment hits from the comment index.

Constructor Summary

LuceneCommentIterator(com.opensymphony.user.User user, CommentService commentService, org.apache.lucene.search.Hits hits)

Method Summary

void	close()
boolean	hasNext()
Comment	next()
Comment	nextComment()
void	remove()
int	size() Returns the total number of comments this iterator contains.

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneCommentIterator

public LuceneCommentIterator(com.opensymphony.user.User user,
                             CommentService commentService,
                             org.apache.lucene.search.Hits hits)

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<Comment>

nextComment

public Comment nextComment()

Specified by:

nextComment in interface CommentIterator

close

public void close()

Specified by:

close in interface CommentIterator

next

public Comment next()

Specified by:

next in interface java.util.Iterator<Comment>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<Comment>

size

public int size()

Description copied from interface: CommentIterator

Returns the total number of comments this iterator contains.

Specified by:

size in interface CommentIterator

Returns:

the total number of comments this iterator contains.