Package com.google.gerrit.server.change

Class ChangeInserter

java.lang.Object

com.google.gerrit.server.change.ChangeInserter

All Implemented Interfaces:

BatchUpdateOp, InsertChangeOp, RepoOnlyOp

public class ChangeInserter
extends Object
implements InsertChangeOp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChangeInserter.Factory

Method Summary

Modifier and Type	Method	Description
Change	createChange(Context ctx)
ChangeInserter	disableValidation()	Disables the commit validation because validation is not needed.
ChangeInserter	disableValidation(com.google.common.collect.ImmutableMap<String,CommitValidationInfo> validationInfos)	Disables the commit validation because the validation has already been done.
Change	getChange()
String	getChangeMessage()
org.eclipse.jgit.transport.ReceiveCommand	getCommand()
org.eclipse.jgit.lib.ObjectId	getCommitId()
PatchSet	getPatchSet()
PatchSet.Id	getPatchSetId()
void	postUpdate(PostUpdateContext ctx)	Override this method to do something after the update e.g.
ChangeInserter	setApprovals(Map<String,Short> approvals)
ChangeInserter	setCherryPickOf(PatchSet.Id cherryPickOf)
ChangeInserter	setConflicts(PatchSet.Conflicts conflicts)
ChangeInserter	setCustomKeyedValues(com.google.common.collect.ImmutableMap<String,String> customKeyedValues)
ChangeInserter	setFireRevisionCreated(boolean fireRevisionCreated)
ChangeInserter	setGroups(List<String> groups)
ChangeInserter	setMessage(String message)
ChangeInserter	setPatchSetDescription(String patchSetDescription)
ChangeInserter	setPrivate(boolean isPrivate)
void	setPushCertificate(String cert)
ChangeInserter	setRequestScopePropagator(RequestScopePropagator r)
ChangeInserter	setRevertOf(Change.Id revertOf)
ChangeInserter	setReviewersAndCcs(Iterable<Account.Id> reviewers, Iterable<Account.Id> ccs)
ChangeInserter	setReviewersAndCcsAsStrings(Iterable<String> reviewers, Iterable<String> ccs)
ChangeInserter	setReviewersAndCcsIgnoreVisibility(Iterable<Account.Id> reviewers, Iterable<Account.Id> ccs)
ChangeInserter	setSendMail(boolean sendMail)
ChangeInserter	setStatus(Change.Status status)
ChangeInserter	setTopic(String topic)
ChangeInserter	setUpdateRef(boolean updateRef)	Deprecated.
ChangeInserter	setValidationOptions(com.google.common.collect.ImmutableListMultimap<String,String> validationOptions)
ChangeInserter	setWorkInProgress(boolean workInProgress)
boolean	updateChange(ChangeContext ctx)	Override this method to modify a change.
void	updateRepo(RepoContext ctx)	Override this method to update the repo.

Methods inherited from class java.lang.Object

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

Method Details

createChange

public Change createChange(Context ctx)
                    throws IOException

Specified by:

createChange in interface InsertChangeOp

Throws:

IOException

getPatchSetId

public PatchSet.Id getPatchSetId()

getCommitId

public org.eclipse.jgit.lib.ObjectId getCommitId()

getChange

public Change getChange()

setTopic

@CanIgnoreReturnValue
public ChangeInserter setTopic(String topic)

setConflicts

@CanIgnoreReturnValue
public ChangeInserter setConflicts(PatchSet.Conflicts conflicts)

setCherryPickOf

@CanIgnoreReturnValue
public ChangeInserter setCherryPickOf(PatchSet.Id cherryPickOf)

setMessage

@CanIgnoreReturnValue
public ChangeInserter setMessage(String message)

setPatchSetDescription

@CanIgnoreReturnValue
public ChangeInserter setPatchSetDescription(String patchSetDescription)

disableValidation

@CanIgnoreReturnValue
public ChangeInserter disableValidation()

Disables the commit validation because validation is not needed.

Returns:

the ChangeInserter instance to allow chaining calls

disableValidation

@CanIgnoreReturnValue
public ChangeInserter disableValidation(com.google.common.collect.ImmutableMap<String,CommitValidationInfo> validationInfos)

Disables the commit validation because the validation has already been done.

The result from the validation that has already been done needs to be provided to this method and is being used to invoke the CommitValidationInfoListener's.

Parameters:

validationInfos - result of validating commitId

Returns:

the ChangeInserter instance to allow chaining calls

setReviewersAndCcs

@CanIgnoreReturnValue
public ChangeInserter setReviewersAndCcs(Iterable<Account.Id> reviewers,
 Iterable<Account.Id> ccs)

setReviewersAndCcsIgnoreVisibility

@CanIgnoreReturnValue
public ChangeInserter setReviewersAndCcsIgnoreVisibility(Iterable<Account.Id> reviewers,
 Iterable<Account.Id> ccs)

setReviewersAndCcsAsStrings

@CanIgnoreReturnValue
public ChangeInserter setReviewersAndCcsAsStrings(Iterable<String> reviewers,
 Iterable<String> ccs)

setPrivate

@CanIgnoreReturnValue
public ChangeInserter setPrivate(boolean isPrivate)

setWorkInProgress

@CanIgnoreReturnValue
public ChangeInserter setWorkInProgress(boolean workInProgress)

setStatus

@CanIgnoreReturnValue
public ChangeInserter setStatus(Change.Status status)

setGroups

@CanIgnoreReturnValue
public ChangeInserter setGroups(List<String> groups)

setCustomKeyedValues

@CanIgnoreReturnValue
public ChangeInserter setCustomKeyedValues(com.google.common.collect.ImmutableMap<String,String> customKeyedValues)

setValidationOptions

@CanIgnoreReturnValue
public ChangeInserter setValidationOptions(com.google.common.collect.ImmutableListMultimap<String,String> validationOptions)

setFireRevisionCreated

@CanIgnoreReturnValue
public ChangeInserter setFireRevisionCreated(boolean fireRevisionCreated)

setSendMail

@CanIgnoreReturnValue
public ChangeInserter setSendMail(boolean sendMail)

setRequestScopePropagator

@CanIgnoreReturnValue
public ChangeInserter setRequestScopePropagator(RequestScopePropagator r)

setRevertOf

@CanIgnoreReturnValue
public ChangeInserter setRevertOf(Change.Id revertOf)

setPushCertificate

public void setPushCertificate(String cert)

getPatchSet

public PatchSet getPatchSet()

setApprovals

@CanIgnoreReturnValue
public ChangeInserter setApprovals(Map<String,Short> approvals)

setUpdateRef

@Deprecated
@CanIgnoreReturnValue
public ChangeInserter setUpdateRef(boolean updateRef)

Deprecated.

Set whether to include the new patch set ref update in this update.

If false, the caller is responsible for creating the patch set ref before executing the containing BatchUpdate.

Should not be used in new code, as it doesn't result in a single atomic batch ref update for code and NoteDb meta refs.

Parameters:

updateRef - whether to update the ref during updateRepo(RepoContext).

getChangeMessage

public String getChangeMessage()

getCommand

public org.eclipse.jgit.transport.ReceiveCommand getCommand()

updateRepo

public void updateRepo(RepoContext ctx)
                throws ResourceConflictException,
IOException

Description copied from interface: RepoOnlyOp

Override this method to update the repo.

Specified by:

updateRepo in interface RepoOnlyOp

Parameters:

ctx - context

Throws:

ResourceConflictException

IOException

updateChange

public boolean updateChange(ChangeContext ctx)
                     throws RestApiException,
IOException,
PermissionBackendException,
org.eclipse.jgit.errors.ConfigInvalidException

Description copied from interface: BatchUpdateOp

Override this method to modify a change.

Specified by:

updateChange in interface BatchUpdateOp

Parameters:

ctx - context

Returns:

whether anything was changed that might require a write to the metadata storage.

Throws:

RestApiException

IOException

PermissionBackendException

org.eclipse.jgit.errors.ConfigInvalidException

postUpdate

public void postUpdate(PostUpdateContext ctx)
                throws Exception

Description copied from interface: RepoOnlyOp

Override this method to do something after the update e.g. send email or run hooks

Specified by:

postUpdate in interface RepoOnlyOp

Parameters:

ctx - context

Throws:

Exception