org.gitective.core.filter.commit

Class NoteContentFilter

java.lang.Object

org.eclipse.jgit.revwalk.filter.RevFilter

org.gitective.core.filter.commit.CommitFilter

org.gitective.core.filter.commit.NoteContentFilter

All Implemented Interfaces:

Cloneable

public class NoteContentFilter
extends CommitFilter

Filter that looks up the notes associated with each commit visited and provides them include(RevCommit, Note, String)

Field Summary

Fields inherited from class org.gitective.core.filter.commit.CommitFilter

repository

Fields inherited from class org.eclipse.jgit.revwalk.filter.RevFilter

ALL, MERGE_BASE, NO_MERGES, NONE

Constructor Summary

Constructors

Constructor and Description
NoteContentFilter()

Method Summary

Methods

Modifier and Type	Method and Description
org.eclipse.jgit.revwalk.filter.RevFilter	clone() Clones this filter.
protected String	getContent(org.eclipse.jgit.notes.Note note) Get content of note as string
protected String[]	getNoteRefs(org.eclipse.jgit.lib.Repository repository) Get note refs from repository to use during commit walks.
protected boolean	include(org.eclipse.jgit.revwalk.RevCommit commit, org.eclipse.jgit.notes.Note note) Handle note associate with given commit.
protected boolean	include(org.eclipse.jgit.revwalk.RevCommit commit, org.eclipse.jgit.notes.Note note, String content) Handle note content associated with given commit.
boolean	include(org.eclipse.jgit.revwalk.RevWalk walker, org.eclipse.jgit.revwalk.RevCommit commit)
CommitFilter	setRepository(org.eclipse.jgit.lib.Repository repository) Set the repository for the walk that is about to begin.

Methods inherited from class org.gitective.core.filter.commit.CommitFilter

include, reset, setStop, throwIOException

Methods inherited from class org.eclipse.jgit.revwalk.filter.RevFilter

negate, requiresCommitBody, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteContentFilter

public NoteContentFilter()

Method Detail

setRepository

public CommitFilter setRepository(org.eclipse.jgit.lib.Repository repository)

Description copied from class: CommitFilter

Set the repository for the walk that is about to begin.

Overrides:

setRepository in class CommitFilter

Returns:

this filter

getNoteRefs

protected String[] getNoteRefs(org.eclipse.jgit.lib.Repository repository)

Get note refs from repository to use during commit walks.

Parameters:

repository - non-null

Returns:

non-null array of ref names

include

public boolean include(org.eclipse.jgit.revwalk.RevWalk walker,
              org.eclipse.jgit.revwalk.RevCommit commit)
                throws IOException

Specified by:

include in class org.eclipse.jgit.revwalk.filter.RevFilter

Throws:

IOException

getContent

protected String getContent(org.eclipse.jgit.notes.Note note)

Get content of note as string

Parameters:

note -

Returns:

string

include

protected boolean include(org.eclipse.jgit.revwalk.RevCommit commit,
              org.eclipse.jgit.notes.Note note)

Handle note associate with given commit.

This method calls include(RevCommit, Note, String) by default with the content read from the blob associated with the note, sub-classes should override if needed.

Parameters:

commit -

note - non-null note

Returns:

true to continue, false to abort

include

protected boolean include(org.eclipse.jgit.revwalk.RevCommit commit,
              org.eclipse.jgit.notes.Note note,
              String content)

Handle note content associated with given commit.

This method always returns true by default and sub-classes should override.

Parameters:

commit -

note -

content -

Returns:

true to continue, false to abort

clone

public org.eclipse.jgit.revwalk.filter.RevFilter clone()

Description copied from class: CommitFilter

Clones this filter.

The default implementation throws a UnsupportedOperationException and sub-classes should override if filter cloning is supported.

Overrides:

clone in class CommitFilter

See Also:

RevFilter.clone()