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()`
`void`	`cacheFromSource(ChangeDataSource s)`
`com.google.gerrit.reviewdb.client.Change`	`change()`
`ChangeControl`	`changeControl()`
`ChangeData.ChangedLines`	`changedLines()`
`java.util.Collection<com.google.gerrit.reviewdb.client.PatchLineComment>`	`comments()`
`java.util.List<org.eclipse.jgit.revwalk.FooterLine>`	`commitFooters()`
`java.lang.String`	`commitMessage()`
`java.util.List<com.google.gerrit.reviewdb.client.PatchSetApproval>`	`currentApprovals()`
`java.util.List<java.lang.String>`	`currentFilePaths()`
`com.google.gerrit.reviewdb.client.PatchSet`	`currentPatchSet()`
`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)`
`java.util.List<java.lang.String>`	`filePaths(com.google.gerrit.reviewdb.client.PatchSet ps)`
`com.google.gerrit.reviewdb.client.Change.Id`	`getId()`
`java.util.List<com.google.gerrit.common.data.SubmitRecord>`	`getSubmitRecords()`
`boolean`	`hasChangeControl()`
`boolean`	`isFromSource(ChangeDataSource s)`
`java.util.List<com.google.gerrit.reviewdb.client.ChangeMessage>`	`messages()`
`ChangeNotes`	`notes()`
`com.google.gerrit.reviewdb.client.PatchSet`	`patch(com.google.gerrit.reviewdb.client.PatchSet.Id psId)`
`java.util.Collection<com.google.gerrit.reviewdb.client.PatchSet>`	`patches()`
`com.google.common.collect.SetMultimap<ReviewerState,com.google.gerrit.reviewdb.client.Account.Id>`	`reviewers()`
`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`	`setSubmitRecords(java.util.List<com.google.gerrit.common.data.SubmitRecord> records)`
`java.lang.String`	`toString()`

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

Method Detail

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

isFromSource

public boolean isFromSource(ChangeDataSource s)

cacheFromSource

public void cacheFromSource(ChangeDataSource s)

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 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

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 NoSuchChangeException,
                                      java.io.IOException,
                                      com.google.gwtorm.server.OrmException

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

commitFooters

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

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

patches

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

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

patch

public com.google.gerrit.reviewdb.client.PatchSet patch(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

comments

public java.util.Collection<com.google.gerrit.reviewdb.client.PatchLineComment> comments()
                                                                                  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()

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

ensureChangeLoaded

ensureAllPatchSetsLoaded

ensureCurrentPatchSetLoaded

ensureCurrentApprovalsLoaded

isFromSource

cacheFromSource

setCurrentFilePaths

currentFilePaths

filePaths

changedLines

setChangedLines

getId

hasChangeControl

changeControl

change

notes

currentPatchSet

currentApprovals

setCurrentApprovals

commitMessage

commitFooters

patches

patch

approvals

reviewers

comments

messages

setSubmitRecords

getSubmitRecords

toString