com.google.gerrit.server

Class ApprovalsUtil

java.lang.Object

com.google.gerrit.server.ApprovalsUtil

public class ApprovalsUtil
extends Object

Utility functions to manipulate patchset approvals.

Approvals are overloaded, they represent both approvals and reviewers which should be CCed on a change. To ensure that reviewers are not lost there must always be an approval on each patchset for each reviewer, even if the reviewer hasn't actually given a score to the change. To mark the "no score" case, a dummy approval, which may live in any of the available categories, with a score of 0 is used.

The methods in this class only modify the gwtorm database.

Constructor Summary

Constructors

Constructor and Description
ApprovalsUtil(NotesMigration migration, IdentifiedUser.GenericFactory userFactory, ChangeControl.GenericFactory changeControlFactory, ApprovalCopier copier)

Method Summary

Modifier and Type	Method and Description
Iterable<PatchSetApproval>	addApprovalsForNewPatchSet(ReviewDb db, ChangeUpdate update, LabelTypes labelTypes, PatchSet ps, ChangeControl changeCtl, Map<String,Short> approvals) Adds approvals to ChangeUpdate for a new patch set, and writes to ReviewDb.
Collection<Account.Id>	addCcs(ChangeNotes notes, ChangeUpdate update, Collection<Account.Id> wantCCs) Adds accounts to a change as reviewers in the CC state.
List<PatchSetApproval>	addReviewers(ReviewDb db, ChangeNotes notes, ChangeUpdate update, LabelTypes labelTypes, Change change, Iterable<Account.Id> wantReviewers)
List<PatchSetApproval>	addReviewers(ReviewDb db, ChangeUpdate update, LabelTypes labelTypes, Change change, PatchSet ps, PatchSetInfo info, Iterable<Account.Id> wantReviewers, Collection<Account.Id> existingReviewers)
com.google.common.collect.ListMultimap<PatchSet.Id,PatchSetApproval>	byChange(ReviewDb db, ChangeNotes notes)
Iterable<PatchSetApproval>	byPatchSet(ReviewDb db, ChangeControl ctl, PatchSet.Id psId)
Iterable<PatchSetApproval>	byPatchSetUser(ReviewDb db, ChangeControl ctl, PatchSet.Id psId, Account.Id accountId)
static void	checkLabel(LabelTypes labelTypes, String name, Short value)
ReviewerSet	getReviewers(ChangeNotes notes, Iterable<PatchSetApproval> allApprovals) Get all reviewers and CCed accounts for a change.
ReviewerSet	getReviewers(ReviewDb db, ChangeNotes notes) Get all reviewers for a change.
List<ReviewerStatusUpdate>	getReviewerUpdates(ChangeNotes notes) Get updates to reviewer set.
static PatchSetApproval	getSubmitter(PatchSet.Id c, Iterable<PatchSetApproval> approvals)
PatchSetApproval	getSubmitter(ReviewDb db, ChangeNotes notes, PatchSet.Id c)
static PatchSetApproval	newApproval(PatchSet.Id psId, CurrentUser user, LabelId labelId, int value, Date when)
static String	renderMessageWithApprovals(int patchSetId, Map<String,Short> n, Map<String,PatchSetApproval> c)
static List<PatchSetApproval>	sortApprovals(Iterable<PatchSetApproval> approvals)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApprovalsUtil

@Inject
public ApprovalsUtil(NotesMigration migration,
                             IdentifiedUser.GenericFactory userFactory,
                             ChangeControl.GenericFactory changeControlFactory,
                             ApprovalCopier copier)

Method Detail

sortApprovals

public static List<PatchSetApproval> sortApprovals(Iterable<PatchSetApproval> approvals)

newApproval

public static PatchSetApproval newApproval(PatchSet.Id psId,
                                           CurrentUser user,
                                           LabelId labelId,
                                           int value,
                                           Date when)

getReviewers

public ReviewerSet getReviewers(ReviewDb db,
                                ChangeNotes notes)
                         throws com.google.gwtorm.server.OrmException

Get all reviewers for a change.

Parameters:

db - review database.

notes - change notes.

Returns:

reviewers for the change.

Throws:

com.google.gwtorm.server.OrmException - if reviewers for the change could not be read.

getReviewers

public ReviewerSet getReviewers(ChangeNotes notes,
                                Iterable<PatchSetApproval> allApprovals)
                         throws com.google.gwtorm.server.OrmException

Get all reviewers and CCed accounts for a change.

Parameters:

allApprovals - all approvals to consider; must all belong to the same change.

Returns:

reviewers for the change.

Throws:

com.google.gwtorm.server.OrmException - if reviewers for the change could not be read.

getReviewerUpdates

public List<ReviewerStatusUpdate> getReviewerUpdates(ChangeNotes notes)
                                              throws com.google.gwtorm.server.OrmException

Get updates to reviewer set. Always returns empty list for ReviewDb.

Parameters:

notes - change notes.

Returns:

reviewer updates for the change.

Throws:

com.google.gwtorm.server.OrmException - if reviewer updates for the change could not be read.

addReviewers

public List<PatchSetApproval> addReviewers(ReviewDb db,
                                           ChangeUpdate update,
                                           LabelTypes labelTypes,
                                           Change change,
                                           PatchSet ps,
                                           PatchSetInfo info,
                                           Iterable<Account.Id> wantReviewers,
                                           Collection<Account.Id> existingReviewers)
                                    throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

addReviewers

public List<PatchSetApproval> addReviewers(ReviewDb db,
                                           ChangeNotes notes,
                                           ChangeUpdate update,
                                           LabelTypes labelTypes,
                                           Change change,
                                           Iterable<Account.Id> wantReviewers)
                                    throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

addCcs

public Collection<Account.Id> addCcs(ChangeNotes notes,
                                     ChangeUpdate update,
                                     Collection<Account.Id> wantCCs)
                              throws com.google.gwtorm.server.OrmException

Adds accounts to a change as reviewers in the CC state.

Parameters:

notes - change notes.

update - change update.

wantCCs - accounts to CC.

Returns:

whether a change was made.

Throws:

com.google.gwtorm.server.OrmException

addApprovalsForNewPatchSet

public Iterable<PatchSetApproval> addApprovalsForNewPatchSet(ReviewDb db,
                                                             ChangeUpdate update,
                                                             LabelTypes labelTypes,
                                                             PatchSet ps,
                                                             ChangeControl changeCtl,
                                                             Map<String,Short> approvals)
                                                      throws RestApiException,
                                                             com.google.gwtorm.server.OrmException

Adds approvals to ChangeUpdate for a new patch set, and writes to ReviewDb.

Parameters:

db - review database.

update - change update.

labelTypes - label types for the containing project.

ps - patch set being approved.

changeCtl - change control for user adding approvals.

approvals - approvals to add.

Throws:

RestApiException

com.google.gwtorm.server.OrmException

checkLabel

public static void checkLabel(LabelTypes labelTypes,
                              String name,
                              Short value)
                       throws BadRequestException

Throws:

BadRequestException

byChange

public com.google.common.collect.ListMultimap<PatchSet.Id,PatchSetApproval> byChange(ReviewDb db,
                                                                                     ChangeNotes notes)
                                                                              throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

byPatchSet

public Iterable<PatchSetApproval> byPatchSet(ReviewDb db,
                                             ChangeControl ctl,
                                             PatchSet.Id psId)
                                      throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

byPatchSetUser

public Iterable<PatchSetApproval> byPatchSetUser(ReviewDb db,
                                                 ChangeControl ctl,
                                                 PatchSet.Id psId,
                                                 Account.Id accountId)
                                          throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

getSubmitter

public PatchSetApproval getSubmitter(ReviewDb db,
                                     ChangeNotes notes,
                                     PatchSet.Id c)

getSubmitter

public static PatchSetApproval getSubmitter(PatchSet.Id c,
                                            Iterable<PatchSetApproval> approvals)

renderMessageWithApprovals

public static String renderMessageWithApprovals(int patchSetId,
                                                Map<String,Short> n,
                                                Map<String,PatchSetApproval> c)