com.google.gerrit.server.notedb

Class ChangeNotes

java.lang.Object

com.google.gerrit.server.git.VersionedMetaData

com.google.gerrit.server.notedb.AbstractChangeNotes<ChangeNotes>

com.google.gerrit.server.notedb.ChangeNotes

public class ChangeNotes
extends AbstractChangeNotes<ChangeNotes>

View of a single Change based on the log of its notes branch.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChangeNotes.Factory

Nested classes/interfaces inherited from class com.google.gerrit.server.git.VersionedMetaData

VersionedMetaData.BatchMetaDataUpdate

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.collect.Ordering<com.google.gerrit.reviewdb.client.ChangeMessage>	MESSAGE_BY_TIME
static java.util.Comparator<com.google.gerrit.reviewdb.client.PatchLineComment>	PLC_ORDER

Fields inherited from class com.google.gerrit.server.notedb.AbstractChangeNotes

migration, repoManager

Fields inherited from class com.google.gerrit.server.git.VersionedMetaData

inserter, newTree, reader

Constructor Summary

Constructors

Constructor and Description
ChangeNotes(GitRepositoryManager repoManager, NotesMigration migration, AllUsersNameProvider allUsersProvider, com.google.gerrit.reviewdb.client.Change change)

Method Summary

Modifier and Type	Method and Description
boolean	containsComment(com.google.gerrit.reviewdb.client.PatchLineComment c)
boolean	containsCommentPublished(com.google.gerrit.reviewdb.client.PatchLineComment c)
com.google.common.collect.ImmutableList<com.google.gerrit.reviewdb.client.Account.Id>	getAllPastReviewers()
com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchSetApproval>	getApprovals()
com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchLineComment>	getBaseComments()
com.google.gerrit.reviewdb.client.Change	getChange()
com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.ChangeMessage>	getChangeMessages()
com.google.common.collect.Table<com.google.gerrit.reviewdb.client.PatchSet.Id,java.lang.String,com.google.gerrit.reviewdb.client.PatchLineComment>	getDraftBaseComments(com.google.gerrit.reviewdb.client.Account.Id author)
com.google.common.collect.Table<com.google.gerrit.reviewdb.client.PatchSet.Id,java.lang.String,com.google.gerrit.reviewdb.client.PatchLineComment>	getDraftPsComments(com.google.gerrit.reviewdb.client.Account.Id author)
com.google.common.collect.ImmutableSet<java.lang.String>	getHashtags()
com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchLineComment>	getPatchSetComments()
protected com.google.gerrit.reviewdb.client.Project.NameKey	getProjectName()
protected java.lang.String	getRefName()
com.google.common.collect.ImmutableSetMultimap<ReviewerState,com.google.gerrit.reviewdb.client.Account.Id>	getReviewers()
com.google.common.collect.ImmutableList<com.google.gerrit.common.data.SubmitRecord>	getSubmitRecords()
protected void	loadDefaults() Load default values for any instance variables when notedb is disabled.
protected void	onLoad() Set up the metadata, parsing any state from the loaded revision.
protected boolean	onSave(org.eclipse.jgit.lib.CommitBuilder commit) Save any changes to the metadata in a commit.
static org.eclipse.jgit.errors.ConfigInvalidException	parseException(com.google.gerrit.reviewdb.client.Change.Id changeId, java.lang.String fmt, java.lang.Object... args)
static com.google.gerrit.reviewdb.client.Account.Id	parseIdent(org.eclipse.jgit.lib.PersonIdent ident, com.google.gerrit.reviewdb.client.Change.Id changeId)

Methods inherited from class com.google.gerrit.server.notedb.AbstractChangeNotes

getChangeId, load, loadRevision, self

Methods inherited from class com.google.gerrit.server.git.VersionedMetaData

commit, commitToNewRef, getObjectId, getRevision, load, load, load, load, openUpdate, readConfig, readFile, readTree, readUTF8, saveConfig, saveFile, saveUTF8, set, set, set

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_BY_TIME

public static final com.google.common.collect.Ordering<com.google.gerrit.reviewdb.client.ChangeMessage> MESSAGE_BY_TIME

PLC_ORDER

public static final java.util.Comparator<com.google.gerrit.reviewdb.client.PatchLineComment> PLC_ORDER

Constructor Detail

ChangeNotes

public ChangeNotes(GitRepositoryManager repoManager,
                   NotesMigration migration,
                   AllUsersNameProvider allUsersProvider,
                   com.google.gerrit.reviewdb.client.Change change)

Method Detail

parseException

public static org.eclipse.jgit.errors.ConfigInvalidException parseException(com.google.gerrit.reviewdb.client.Change.Id changeId,
                                                                            java.lang.String fmt,
                                                                            java.lang.Object... args)

parseIdent

public static com.google.gerrit.reviewdb.client.Account.Id parseIdent(org.eclipse.jgit.lib.PersonIdent ident,
                                                                      com.google.gerrit.reviewdb.client.Change.Id changeId)
                                                               throws org.eclipse.jgit.errors.ConfigInvalidException

Throws:

org.eclipse.jgit.errors.ConfigInvalidException

getChange

public com.google.gerrit.reviewdb.client.Change getChange()

getApprovals

public com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchSetApproval> getApprovals()

getReviewers

public com.google.common.collect.ImmutableSetMultimap<ReviewerState,com.google.gerrit.reviewdb.client.Account.Id> getReviewers()

getHashtags

public com.google.common.collect.ImmutableSet<java.lang.String> getHashtags()

Returns:

a ImmutableSet of all hashtags for this change sorted in alphabetical order.

getAllPastReviewers

public com.google.common.collect.ImmutableList<com.google.gerrit.reviewdb.client.Account.Id> getAllPastReviewers()

Returns:

a list of all users who have ever been a reviewer on this change.

getSubmitRecords

public com.google.common.collect.ImmutableList<com.google.gerrit.common.data.SubmitRecord> getSubmitRecords()

Returns:

submit records stored during the most recent submit; only for changes that were actually submitted.

getChangeMessages

public com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.ChangeMessage> getChangeMessages()

Returns:

change messages by patch set, in chronological order.

getBaseComments

public com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchLineComment> getBaseComments()

Returns:

inline comments on each patchset's base (side == 0).

getPatchSetComments

public com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchLineComment> getPatchSetComments()

Returns:

inline comments on each patchset (side == 1).

getDraftBaseComments

public com.google.common.collect.Table<com.google.gerrit.reviewdb.client.PatchSet.Id,java.lang.String,com.google.gerrit.reviewdb.client.PatchLineComment> getDraftBaseComments(com.google.gerrit.reviewdb.client.Account.Id author)
                                                                                                                                                                        throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

getDraftPsComments

public com.google.common.collect.Table<com.google.gerrit.reviewdb.client.PatchSet.Id,java.lang.String,com.google.gerrit.reviewdb.client.PatchLineComment> getDraftPsComments(com.google.gerrit.reviewdb.client.Account.Id author)
                                                                                                                                                                      throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

containsComment

public boolean containsComment(com.google.gerrit.reviewdb.client.PatchLineComment c)
                        throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

containsCommentPublished

public boolean containsCommentPublished(com.google.gerrit.reviewdb.client.PatchLineComment c)

getRefName

protected java.lang.String getRefName()

Specified by:

getRefName in class VersionedMetaData

Returns:

name of the reference storing this configuration.

onLoad

protected void onLoad()
               throws java.io.IOException,
                      org.eclipse.jgit.errors.ConfigInvalidException

Description copied from class: VersionedMetaData

Set up the metadata, parsing any state from the loaded revision.

Specified by:

onLoad in class VersionedMetaData

Throws:

java.io.IOException

org.eclipse.jgit.errors.ConfigInvalidException

loadDefaults

protected void loadDefaults()

Description copied from class: AbstractChangeNotes

Load default values for any instance variables when notedb is disabled.

Specified by:

loadDefaults in class AbstractChangeNotes<ChangeNotes>

onSave

protected boolean onSave(org.eclipse.jgit.lib.CommitBuilder commit)

Description copied from class: VersionedMetaData

Save any changes to the metadata in a commit.

Specified by:

onSave in class VersionedMetaData

Returns:

true if the commit should proceed, false to abort.

getProjectName

protected com.google.gerrit.reviewdb.client.Project.NameKey getProjectName()

Specified by:

getProjectName in class AbstractChangeNotes<ChangeNotes>

Returns:

the NameKey for the project where the notes should be stored, which is not necessarily the same as the change's project.