Package com.google.gerrit.server.notedb

Class ChangeDraftNotesUpdate

java.lang.Object

com.google.gerrit.server.notedb.AbstractChangeUpdate

com.google.gerrit.server.notedb.ChangeDraftNotesUpdate

All Implemented Interfaces:

ChangeDraftUpdate

public class ChangeDraftNotesUpdate
extends AbstractChangeUpdate
implements ChangeDraftUpdate

A single delta to apply atomically to a change.

This delta contains only draft comments on a single patch set of a change by a single author. This delta will become a single commit in the All-Users repository.

This class is not thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChangeDraftNotesUpdate.Factory

Nested classes/interfaces inherited from interface com.google.gerrit.server.ChangeDraftUpdate

ChangeDraftUpdate.ChangeDraftUpdateFactory

Field Summary

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

accountId, authorIdent, noteUtil, psId, realAccountId, serverIdent, when

Method Summary

Modifier and Type	Method	Description
void	addAllDraftCommentsForDeletion(List<Comment> comments)	Marks all comments for deletion.
void	addDraftCommentForDeletion(HumanComment c)	Marks a comment for deletion.
protected org.eclipse.jgit.lib.CommitBuilder	applyImpl(org.eclipse.jgit.revwalk.RevWalk rw, org.eclipse.jgit.lib.ObjectInserter ins, org.eclipse.jgit.lib.ObjectId curr)	Create a commit containing the contents of this update.
static Optional<ChangeDraftNotesUpdate>	asChangeDraftNotesUpdate(ChangeDraftUpdate obj)
boolean	canRunAsync()
protected Project.NameKey	getProjectName()	Returns the NameKey for the project where the update will be stored, which is not necessarily the same as the change's project.
protected String	getRefName()
boolean	isEmpty()	Whether no updates have been done.
void	markDraftCommentAsPublished(HumanComment c)	Marks a comment for deletion.
void	putDraftComment(HumanComment c)	Creates a draft comment.
protected void	setParentCommit(org.eclipse.jgit.lib.CommitBuilder cb, org.eclipse.jgit.lib.ObjectId parentCommitId)

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

allowWriteToNewRef, bypassMaxUpdates, getAccountId, getChange, getId, getNotes, getNullableAccountId, getPatchSetId, getRealAccountId, getWhen, setPatchSetId

Methods inherited from class java.lang.Object

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

Method Details

putDraftComment

public void putDraftComment(HumanComment c)

Description copied from interface: ChangeDraftUpdate

Creates a draft comment.

Specified by:

putDraftComment in interface ChangeDraftUpdate

markDraftCommentAsPublished

public void markDraftCommentAsPublished(HumanComment c)

Description copied from interface: ChangeDraftUpdate

Marks a comment for deletion. Called when the comment is deleted because the user published it.

NOTE for implementers: The actual deletion of a published draft should only happen after the published comment is successfully updated. For more context, see NoteDbUpdateManager.execute(boolean).

TODO(nitzan) - add generalized support for the above sync issue. The implementation should support deletion of published drafts from multiple ChangeDraftUpdateFactory instances.

Specified by:

markDraftCommentAsPublished in interface ChangeDraftUpdate

addDraftCommentForDeletion

public void addDraftCommentForDeletion(HumanComment c)

Description copied from interface: ChangeDraftUpdate

Marks a comment for deletion. Called when the comment is deleted because the user removed it.

Specified by:

addDraftCommentForDeletion in interface ChangeDraftUpdate

addAllDraftCommentsForDeletion

public void addAllDraftCommentsForDeletion(List<Comment> comments)

Description copied from interface: ChangeDraftUpdate

Marks all comments for deletion. Called when there are inconsistencies between the published comments storage and the drafts one.

Specified by:

addAllDraftCommentsForDeletion in interface ChangeDraftUpdate

canRunAsync

public boolean canRunAsync()

applyImpl

protected org.eclipse.jgit.lib.CommitBuilder applyImpl(org.eclipse.jgit.revwalk.RevWalk rw,
 org.eclipse.jgit.lib.ObjectInserter ins,
 org.eclipse.jgit.lib.ObjectId curr)
                                                throws IOException

Description copied from class: AbstractChangeUpdate

Create a commit containing the contents of this update.

Specified by:

applyImpl in class AbstractChangeUpdate

ins - inserter to write to; callers should not flush.

Returns:

a new commit builder representing this commit, or null to indicate the meta ref should be deleted as a result of this update. The parent, author, and committer fields in the return value are always overwritten. The tree ID may be unset by this method, which indicates to the caller that it should be copied from the parent commit. To indicate that this update is a no-op (but this could not be determined by AbstractChangeUpdate.isEmpty()), return the sentinel AbstractChangeUpdate.NO_OP_UPDATE.

Throws:

IOException - if a lower-level error occurred.

getProjectName

protected Project.NameKey getProjectName()

Description copied from class: AbstractChangeUpdate

Returns the NameKey for the project where the update will be stored, which is not necessarily the same as the change's project.

Specified by:

getProjectName in class AbstractChangeUpdate

getRefName

protected String getRefName()

Specified by:

getRefName in class AbstractChangeUpdate

setParentCommit

protected void setParentCommit(org.eclipse.jgit.lib.CommitBuilder cb,
 org.eclipse.jgit.lib.ObjectId parentCommitId)

Overrides:

setParentCommit in class AbstractChangeUpdate

isEmpty

public boolean isEmpty()

Description copied from class: AbstractChangeUpdate

Whether no updates have been done.

Specified by:

isEmpty in class AbstractChangeUpdate

asChangeDraftNotesUpdate

public static Optional<ChangeDraftNotesUpdate> asChangeDraftNotesUpdate(ChangeDraftUpdate obj)