ChangeData (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.query.change.ChangeData

public class ChangeData
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ChangeData.ChangedLines

static interface ChangeData.Factory

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChangeData.ChangedLines`
`static interface`	`ChangeData.Factory`

Method Summary

Methods
Modifier and Type	Method and Description
`com.google.common.collect.ListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchSetApproval>`	`approvals()`
`static java.util.List<com.google.gerrit.reviewdb.client.Change>`	`asChanges(java.util.List<ChangeData> changeDatas)`
`static java.util.Map<com.google.gerrit.reviewdb.client.Change.Id,ChangeData>`	`asMap(java.util.List<ChangeData> changes)`
`com.google.gerrit.reviewdb.client.Change`	`change()`
`ChangeControl`	`changeControl()`
`ChangeControl`	`changeControl(CurrentUser user)`
`com.google.common.base.Optional<ChangeData.ChangedLines>`	`changedLines()`
`java.util.List<org.eclipse.jgit.revwalk.FooterLine>`	`commitFooters()`
`java.lang.String`	`commitMessage()`
`static ChangeData`	`createForTest(com.google.gerrit.reviewdb.client.Project.NameKey project, com.google.gerrit.reviewdb.client.Change.Id id, int currentPatchSetId)` Create an instance for testing only.
`java.util.List<com.google.gerrit.reviewdb.client.PatchSetApproval>`	`currentApprovals()`
`java.util.List<java.lang.String>`	`currentFilePaths()`
`com.google.gerrit.reviewdb.client.PatchSet`	`currentPatchSet()`
`com.google.gerrit.reviewdb.server.ReviewDb`	`db()`
`java.util.Set<com.google.gerrit.reviewdb.client.Account.Id>`	`draftsByUser()`
`java.util.Set<com.google.gerrit.reviewdb.client.Account.Id>`	`editsByUser()`
`static void`	`ensureAllPatchSetsLoaded(java.lang.Iterable<ChangeData> changes)`
`static void`	`ensureChangeLoaded(java.lang.Iterable<ChangeData> changes)`
`static void`	`ensureCurrentApprovalsLoaded(java.lang.Iterable<ChangeData> changes)`
`static void`	`ensureCurrentPatchSetLoaded(java.lang.Iterable<ChangeData> changes)`
`static void`	`ensureMessagesLoaded(java.lang.Iterable<ChangeData> changes)`
`static void`	`ensureReviewedByLoadedForOpenChanges(java.lang.Iterable<ChangeData> changes)`
`java.util.List<java.lang.String>`	`filePaths(com.google.gerrit.reviewdb.client.PatchSet ps)`
`org.eclipse.jgit.lib.PersonIdent`	`getAuthor()`
`org.eclipse.jgit.lib.PersonIdent`	`getCommitter()`
`com.google.gerrit.reviewdb.client.Change.Id`	`getId()`
`ReviewerSet`	`getReviewers()`
`java.util.List<ReviewerStatusUpdate>`	`getReviewerUpdates()`
`com.google.common.base.Optional<com.google.gerrit.reviewdb.client.PatchSetApproval>`	`getSubmitApproval()`
`java.util.List<com.google.gerrit.common.data.SubmitRecord>`	`getSubmitRecords()`
`boolean`	`hasChangeControl()`
`java.util.Set<java.lang.String>`	`hashtags()`
`java.lang.Boolean`	`isMergeable()`
`java.util.List<com.google.gerrit.reviewdb.client.ChangeMessage>`	`messages()`
`ChangeNotes`	`notes()`
`com.google.gerrit.reviewdb.client.PatchSet`	`patchSet(com.google.gerrit.reviewdb.client.PatchSet.Id psId)`
`java.util.Collection<com.google.gerrit.reviewdb.client.PatchSet>`	`patchSets()`
`com.google.gerrit.reviewdb.client.Project.NameKey`	`project()`
`java.util.Collection<com.google.gerrit.reviewdb.client.PatchLineComment>`	`publishedComments()`
`com.google.gerrit.reviewdb.client.Change`	`reloadChange()`
`java.util.Set<com.google.gerrit.reviewdb.client.Account.Id>`	`reviewedBy()`
`ReviewerSet`	`reviewers()`
`java.util.List<ReviewerStatusUpdate>`	`reviewerUpdates()`
`void`	`setChange(com.google.gerrit.reviewdb.client.Change c)`
`void`	`setChangedLines(int insertions, int deletions)`
`void`	`setCurrentApprovals(java.util.List<com.google.gerrit.reviewdb.client.PatchSetApproval> approvals)`
`void`	`setCurrentFilePaths(java.util.List<java.lang.String> filePaths)`
`void`	`setHashtags(java.util.Set<java.lang.String> hashtags)`
`void`	`setMergeable(java.lang.Boolean mergeable)`
`void`	`setNoChangedLines()`
`void`	`setPatchSets(java.util.Collection<com.google.gerrit.reviewdb.client.PatchSet> patchSets)`
`void`	`setReviewedBy(java.util.Set<com.google.gerrit.reviewdb.client.Account.Id> reviewedBy)`
`void`	`setReviewers(ReviewerSet reviewers)`
`void`	`setReviewerUpdates(java.util.List<ReviewerStatusUpdate> reviewerUpdates)`
`void`	`setStarredBy(java.util.Set<com.google.gerrit.reviewdb.client.Account.Id> starredByUser)` Deprecated.
`void`	`setStars(com.google.common.collect.Multimap<com.google.gerrit.reviewdb.client.Account.Id,java.lang.String> stars)`
`void`	`setSubmitRecords(java.util.List<com.google.gerrit.common.data.SubmitRecord> records)`
`java.util.Set<com.google.gerrit.reviewdb.client.Account.Id>`	`starredBy()` Deprecated.
`com.google.common.collect.ImmutableMultimap<com.google.gerrit.reviewdb.client.Account.Id,java.lang.String>`	`stars()`
`com.google.gerrit.common.data.SubmitTypeRecord`	`submitTypeRecord()`
`java.lang.String`	`toString()`
`java.util.Collection<com.google.gerrit.reviewdb.client.PatchSet>`	`visiblePatchSets()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

asChanges

public static java.util.List<com.google.gerrit.reviewdb.client.Change> asChanges(java.util.List<ChangeData> changeDatas)
                                                                          throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

asMap

public static java.util.Map<com.google.gerrit.reviewdb.client.Change.Id,ChangeData> asMap(java.util.List<ChangeData> changes)

ensureChangeLoaded

public static void ensureChangeLoaded(java.lang.Iterable<ChangeData> changes)
                               throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

ensureAllPatchSetsLoaded

public static void ensureAllPatchSetsLoaded(java.lang.Iterable<ChangeData> changes)
                                     throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

ensureCurrentPatchSetLoaded

public static void ensureCurrentPatchSetLoaded(java.lang.Iterable<ChangeData> changes)
                                        throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

ensureCurrentApprovalsLoaded

public static void ensureCurrentApprovalsLoaded(java.lang.Iterable<ChangeData> changes)
                                         throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

ensureMessagesLoaded

public static void ensureMessagesLoaded(java.lang.Iterable<ChangeData> changes)
                                 throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

ensureReviewedByLoadedForOpenChanges

public static void ensureReviewedByLoadedForOpenChanges(java.lang.Iterable<ChangeData> changes)
                                                 throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

createForTest

public static ChangeData createForTest(com.google.gerrit.reviewdb.client.Project.NameKey project,
                       com.google.gerrit.reviewdb.client.Change.Id id,
                       int currentPatchSetId)

Create an instance for testing only.

Attempting to lazy load data will fail with NPEs. Callers may consider manually setting fields that can be set.

Parameters:: id - change ID
Returns:: instance for testing.

db

public com.google.gerrit.reviewdb.server.ReviewDb db()

setCurrentFilePaths

public void setCurrentFilePaths(java.util.List<java.lang.String> filePaths)
                         throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

currentFilePaths

public java.util.List<java.lang.String> currentFilePaths()
                                                  throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

filePaths

public java.util.List<java.lang.String> filePaths(com.google.gerrit.reviewdb.client.PatchSet ps)
                                           throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

changedLines

public com.google.common.base.Optional<ChangeData.ChangedLines> changedLines()
                                                                      throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

setChangedLines

public void setChangedLines(int insertions,
                   int deletions)

setNoChangedLines
```
public void setNoChangedLines()
```

getId

public com.google.gerrit.reviewdb.client.Change.Id getId()

project

public com.google.gerrit.reviewdb.client.Project.NameKey project()
                                                          throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

hasChangeControl
```
public boolean hasChangeControl()
```

changeControl

public ChangeControl changeControl()
                            throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

changeControl

public ChangeControl changeControl(CurrentUser user)
                            throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

change

public com.google.gerrit.reviewdb.client.Change change()
                                                throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

setChange

public void setChange(com.google.gerrit.reviewdb.client.Change c)

reloadChange

public com.google.gerrit.reviewdb.client.Change reloadChange()
                                                      throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

notes

public ChangeNotes notes()
                  throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

currentPatchSet

public com.google.gerrit.reviewdb.client.PatchSet currentPatchSet()
                                                           throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

currentApprovals

public java.util.List<com.google.gerrit.reviewdb.client.PatchSetApproval> currentApprovals()
                                                                                    throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

setCurrentApprovals

public void setCurrentApprovals(java.util.List<com.google.gerrit.reviewdb.client.PatchSetApproval> approvals)

commitMessage

public java.lang.String commitMessage()
                               throws java.io.IOException,
                                      com.google.gwtorm.server.OrmException

Throws:: java.io.IOException; com.google.gwtorm.server.OrmException

commitFooters

public java.util.List<org.eclipse.jgit.revwalk.FooterLine> commitFooters()
                                                                  throws java.io.IOException,
                                                                         com.google.gwtorm.server.OrmException

Throws:: java.io.IOException; com.google.gwtorm.server.OrmException

getAuthor

public org.eclipse.jgit.lib.PersonIdent getAuthor()
                                           throws java.io.IOException,
                                                  com.google.gwtorm.server.OrmException

Throws:: java.io.IOException; com.google.gwtorm.server.OrmException

getCommitter

public org.eclipse.jgit.lib.PersonIdent getCommitter()
                                              throws java.io.IOException,
                                                     com.google.gwtorm.server.OrmException

Throws:: java.io.IOException; com.google.gwtorm.server.OrmException

patchSets

public java.util.Collection<com.google.gerrit.reviewdb.client.PatchSet> patchSets()
                                                                           throws com.google.gwtorm.server.OrmException

Returns:: patches for the change, in patch set ID order.
Throws:: com.google.gwtorm.server.OrmException - an error occurred reading the database.

visiblePatchSets

public java.util.Collection<com.google.gerrit.reviewdb.client.PatchSet> visiblePatchSets()
                                                                                  throws com.google.gwtorm.server.OrmException

Returns:: patches for the change visible to the current user.
Throws:: com.google.gwtorm.server.OrmException - an error occurred reading the database.

setPatchSets

public void setPatchSets(java.util.Collection<com.google.gerrit.reviewdb.client.PatchSet> patchSets)

patchSet

public com.google.gerrit.reviewdb.client.PatchSet patchSet(com.google.gerrit.reviewdb.client.PatchSet.Id psId)
                                                    throws com.google.gwtorm.server.OrmException

Returns:: patch with the given ID, or null if it does not exist.
Throws:: com.google.gwtorm.server.OrmException - an error occurred reading the database.

approvals

public com.google.common.collect.ListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchSetApproval> approvals()
                                                                                                                                                   throws com.google.gwtorm.server.OrmException

Returns:: all patch set approvals for the change, keyed by ID, ordered by timestamp within each patch set.
Throws:: com.google.gwtorm.server.OrmException - an error occurred reading the database.

getSubmitApproval

public com.google.common.base.Optional<com.google.gerrit.reviewdb.client.PatchSetApproval> getSubmitApproval()
                                                                                                      throws com.google.gwtorm.server.OrmException

Returns:: The submit ('SUBM') approval label
Throws:: com.google.gwtorm.server.OrmException - an error occurred reading the database.

reviewers

public ReviewerSet reviewers()
                      throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

setReviewers

public void setReviewers(ReviewerSet reviewers)

getReviewers
```
public ReviewerSet getReviewers()
```

reviewerUpdates

public java.util.List<ReviewerStatusUpdate> reviewerUpdates()
                                                     throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

setReviewerUpdates

public void setReviewerUpdates(java.util.List<ReviewerStatusUpdate> reviewerUpdates)

getReviewerUpdates

public java.util.List<ReviewerStatusUpdate> getReviewerUpdates()

publishedComments

public java.util.Collection<com.google.gerrit.reviewdb.client.PatchLineComment> publishedComments()
                                                                                           throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

messages

public java.util.List<com.google.gerrit.reviewdb.client.ChangeMessage> messages()
                                                                         throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

setSubmitRecords

public void setSubmitRecords(java.util.List<com.google.gerrit.common.data.SubmitRecord> records)

getSubmitRecords

public java.util.List<com.google.gerrit.common.data.SubmitRecord> getSubmitRecords()

submitTypeRecord

public com.google.gerrit.common.data.SubmitTypeRecord submitTypeRecord()
                                                                throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

setMergeable

public void setMergeable(java.lang.Boolean mergeable)

isMergeable

public java.lang.Boolean isMergeable()
                              throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

editsByUser

public java.util.Set<com.google.gerrit.reviewdb.client.Account.Id> editsByUser()
                                                                        throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

draftsByUser

public java.util.Set<com.google.gerrit.reviewdb.client.Account.Id> draftsByUser()
                                                                         throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

reviewedBy

public java.util.Set<com.google.gerrit.reviewdb.client.Account.Id> reviewedBy()
                                                                       throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

setReviewedBy

public void setReviewedBy(java.util.Set<com.google.gerrit.reviewdb.client.Account.Id> reviewedBy)

hashtags

public java.util.Set<java.lang.String> hashtags()
                                         throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

setHashtags

public void setHashtags(java.util.Set<java.lang.String> hashtags)

starredBy

@Deprecated
public java.util.Set<com.google.gerrit.reviewdb.client.Account.Id> starredBy()
                                                                      throws com.google.gwtorm.server.OrmException

Deprecated.

Throws:: com.google.gwtorm.server.OrmException

setStarredBy

@Deprecated
public void setStarredBy(java.util.Set<com.google.gerrit.reviewdb.client.Account.Id> starredByUser)

Deprecated.

stars

public com.google.common.collect.ImmutableMultimap<com.google.gerrit.reviewdb.client.Account.Id,java.lang.String> stars()
                                                                                                                 throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

setStars

public void setStars(com.google.common.collect.Multimap<com.google.gerrit.reviewdb.client.Account.Id,java.lang.String> stars)

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

Class ChangeData

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

asChanges

asMap

ensureChangeLoaded

ensureAllPatchSetsLoaded

ensureCurrentPatchSetLoaded

ensureCurrentApprovalsLoaded

ensureMessagesLoaded

ensureReviewedByLoadedForOpenChanges

createForTest

db

setCurrentFilePaths

currentFilePaths

filePaths

changedLines

setChangedLines

setNoChangedLines

getId

project

hasChangeControl

changeControl

changeControl

change

setChange

reloadChange

notes

currentPatchSet

currentApprovals

setCurrentApprovals

commitMessage

commitFooters

getAuthor

getCommitter

patchSets

visiblePatchSets

setPatchSets

patchSet

approvals

getSubmitApproval

reviewers

setReviewers

getReviewers

reviewerUpdates

setReviewerUpdates

getReviewerUpdates

publishedComments

messages

setSubmitRecords

getSubmitRecords

submitTypeRecord

setMergeable

isMergeable

editsByUser

draftsByUser

reviewedBy

setReviewedBy

hashtags

setHashtags

starredBy

setStarredBy

stars

setStars

toString