ChangeData (Gerrit Review Plugin API Documentation)

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

```
public class ChangeData
extends 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 List<com.google.gerrit.reviewdb.client.Change>`	`asChanges(List<ChangeData> changeDatas)`
`static Map<com.google.gerrit.reviewdb.client.Change.Id,ChangeData>`	`asMap(List<ChangeData> changes)`
`void`	`cacheFromSource(ChangeDataSource s)`
`com.google.gerrit.reviewdb.client.Change`	`change()`
`ChangeControl`	`changeControl()`
`ChangeData.ChangedLines`	`changedLines()`
`List<org.eclipse.jgit.revwalk.FooterLine>`	`commitFooters()`
`String`	`commitMessage()`
`static ChangeData`	`createForTest(com.google.gerrit.reviewdb.client.Change.Id id, int currentPatchSetId)` Create an instance for testing only.
`List<com.google.gerrit.reviewdb.client.PatchSetApproval>`	`currentApprovals()`
`List<String>`	`currentFilePaths()`
`com.google.gerrit.reviewdb.client.PatchSet`	`currentPatchSet()`
`com.google.gerrit.reviewdb.server.ReviewDb`	`db()`
`Set<com.google.gerrit.reviewdb.client.Account.Id>`	`editsByUser()`
`static void`	`ensureAllPatchSetsLoaded(Iterable<ChangeData> changes)`
`static void`	`ensureChangeLoaded(Iterable<ChangeData> changes)`
`static void`	`ensureCurrentApprovalsLoaded(Iterable<ChangeData> changes)`
`static void`	`ensureCurrentPatchSetLoaded(Iterable<ChangeData> changes)`
`static void`	`ensureMessagesLoaded(Iterable<ChangeData> changes)`
`static void`	`ensureReviewedByLoadedForOpenChanges(Iterable<ChangeData> changes)`
`List<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()`
`List<com.google.gerrit.common.data.SubmitRecord>`	`getSubmitRecords()`
`boolean`	`hasChangeControl()`
`boolean`	`isFromSource(ChangeDataSource s)`
`Boolean`	`isMergeable()`
`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)`
`Collection<com.google.gerrit.reviewdb.client.PatchSet>`	`patchSets()`
`Collection<com.google.gerrit.reviewdb.client.PatchLineComment>`	`publishedComments()`
`com.google.gerrit.reviewdb.client.Change`	`reloadChange()`
`Set<com.google.gerrit.reviewdb.client.Account.Id>`	`reviewedBy()`
`com.google.common.collect.SetMultimap<ReviewerState,com.google.gerrit.reviewdb.client.Account.Id>`	`reviewers()`
`void`	`setChange(com.google.gerrit.reviewdb.client.Change c)`
`void`	`setChangedLines(int insertions, int deletions)`
`void`	`setCurrentApprovals(List<com.google.gerrit.reviewdb.client.PatchSetApproval> approvals)`
`void`	`setCurrentFilePaths(List<String> filePaths)`
`void`	`setMergeable(Boolean mergeable)`
`void`	`setPatchSets(Collection<com.google.gerrit.reviewdb.client.PatchSet> patchSets)`
`void`	`setReviewedBy(Set<com.google.gerrit.reviewdb.client.Account.Id> reviewedBy)`
`void`	`setSubmitRecords(List<com.google.gerrit.common.data.SubmitRecord> records)`
`String`	`toString()`
`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 List<com.google.gerrit.reviewdb.client.Change> asChanges(List<ChangeData> changeDatas)
                                                                throws com.google.gwtorm.server.OrmException

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

asMap

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

ensureChangeLoaded

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

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

ensureAllPatchSetsLoaded

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

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

ensureCurrentPatchSetLoaded

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

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

ensureCurrentApprovalsLoaded

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

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

ensureMessagesLoaded

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

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

ensureReviewedByLoadedForOpenChanges

public static void ensureReviewedByLoadedForOpenChanges(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.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()

isFromSource

public boolean isFromSource(ChangeDataSource s)

cacheFromSource

public void cacheFromSource(ChangeDataSource s)

setCurrentFilePaths

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

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

currentFilePaths

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

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

filePaths

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

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

changedLines

public ChangeData.ChangedLines changedLines()
                                     throws com.google.gwtorm.server.OrmException

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

setChangedLines

public void setChangedLines(int insertions,
                   int deletions)

getId

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

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

changeControl

public ChangeControl changeControl()
                            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 List<com.google.gerrit.reviewdb.client.PatchSetApproval> currentApprovals()
                                                                          throws com.google.gwtorm.server.OrmException

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

setCurrentApprovals

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

commitMessage

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

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

commitFooters

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

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

getAuthor

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

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

getCommitter

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

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

patchSets

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

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

visiblePatchSets

public 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(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.

reviewers

public com.google.common.collect.SetMultimap<ReviewerState,com.google.gerrit.reviewdb.client.Account.Id> reviewers()
                                                                                                            throws com.google.gwtorm.server.OrmException

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

publishedComments

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

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

messages

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

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

setSubmitRecords

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

getSubmitRecords

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

setMergeable

public void setMergeable(Boolean mergeable)

isMergeable

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

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

editsByUser

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

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

reviewedBy

public 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(Set<com.google.gerrit.reviewdb.client.Account.Id> reviewedBy)

toString
```
public String toString()
```
Overrides:

toString in class 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

isFromSource

cacheFromSource

setCurrentFilePaths

currentFilePaths

filePaths

changedLines

setChangedLines

getId

hasChangeControl

changeControl

change

setChange

reloadChange

notes

currentPatchSet

currentApprovals

setCurrentApprovals

commitMessage

commitFooters

getAuthor

getCommitter

patchSets

visiblePatchSets

setPatchSets

patchSet

approvals

reviewers

publishedComments

messages

setSubmitRecords

getSubmitRecords

setMergeable

isMergeable

editsByUser

reviewedBy

setReviewedBy

toString