ChangeNotes (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.git.VersionedMetaData
- - com.google.gerrit.server.notedb.AbstractChangeNotes<ChangeNotes>
  - - com.google.gerrit.server.notedb.ChangeNotes

public class ChangeNotes
extends AbstractChangeNotes<ChangeNotes>

View of a single Change based on the log of its notes branch.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ChangeNotes.Factory
- Nested classes/interfaces inherited from class com.google.gerrit.server.git.VersionedMetaData
  VersionedMetaData.BatchMetaDataUpdate

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChangeNotes.Factory`

Field Summary

Fields
Modifier and Type	Field and Description
`static com.google.common.collect.Ordering<com.google.gerrit.reviewdb.client.ChangeMessage>`	`MESSAGE_BY_TIME`
`static Comparator<com.google.gerrit.reviewdb.client.PatchLineComment>`	`PatchLineCommentComparator`

Fields inherited from class com.google.gerrit.server.notedb.AbstractChangeNotes
repoManager

Fields inherited from class com.google.gerrit.server.git.VersionedMetaData
inserter, newTree, reader

Constructor Summary

Constructors
Constructor and Description

ChangeNotes(GitRepositoryManager repoManager, com.google.gerrit.reviewdb.client.Change change)

Constructors
Constructor and Description
`ChangeNotes(GitRepositoryManager repoManager, com.google.gerrit.reviewdb.client.Change change)`

Method Summary

Methods
Modifier and Type	Method and Description
`com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchSetApproval>`	`getApprovals()`
`com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchLineComment>`	`getBaseComments()`
`com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.ChangeMessage>`	`getChangeMessages()`
`com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchLineComment>`	`getPatchSetComments()`
`protected com.google.gerrit.reviewdb.client.Project.NameKey`	`getProjectName()`
`protected String`	`getRefName()`
`com.google.common.collect.ImmutableSetMultimap<ReviewerState,com.google.gerrit.reviewdb.client.Account.Id>`	`getReviewers()`
`com.google.common.collect.ImmutableList<com.google.gerrit.common.data.SubmitRecord>`	`getSubmitRecords()`
`protected void`	`onLoad()` Set up the metadata, parsing any state from the loaded revision.
`protected boolean`	`onSave(org.eclipse.jgit.lib.CommitBuilder commit)` Save any changes to the metadata in a commit.
`static org.eclipse.jgit.errors.ConfigInvalidException`	`parseException(com.google.gerrit.reviewdb.client.Change.Id changeId, String fmt, Object... args)`
`static com.google.gerrit.reviewdb.client.Account.Id`	`parseIdent(org.eclipse.jgit.lib.PersonIdent ident, com.google.gerrit.reviewdb.client.Change.Id changeId)`

Methods inherited from class com.google.gerrit.server.notedb.AbstractChangeNotes
getChange, getChangeId, load, self

Methods inherited from class com.google.gerrit.server.git.VersionedMetaData
commit, commitToNewRef, getObjectId, getRevision, load, load, load, load, openUpdate, readConfig, readFile, readTree, readUTF8, saveConfig, saveFile, saveUTF8, set, set, set

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

Field Detail

MESSAGE_BY_TIME

public static final com.google.common.collect.Ordering<com.google.gerrit.reviewdb.client.ChangeMessage> MESSAGE_BY_TIME

PatchLineCommentComparator

public static Comparator<com.google.gerrit.reviewdb.client.PatchLineComment> PatchLineCommentComparator

Constructor Detail

ChangeNotes

public ChangeNotes(GitRepositoryManager repoManager,
           com.google.gerrit.reviewdb.client.Change change)

Method Detail

parseException

public static org.eclipse.jgit.errors.ConfigInvalidException parseException(com.google.gerrit.reviewdb.client.Change.Id changeId,
                                                            String fmt,
                                                            Object... args)

parseIdent

public static com.google.gerrit.reviewdb.client.Account.Id parseIdent(org.eclipse.jgit.lib.PersonIdent ident,
                                                      com.google.gerrit.reviewdb.client.Change.Id changeId)
                                                               throws org.eclipse.jgit.errors.ConfigInvalidException

Throws:: org.eclipse.jgit.errors.ConfigInvalidException

getApprovals

public com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchSetApproval> getApprovals()

getReviewers

public com.google.common.collect.ImmutableSetMultimap<ReviewerState,com.google.gerrit.reviewdb.client.Account.Id> getReviewers()

getSubmitRecords
```
public com.google.common.collect.ImmutableList<com.google.gerrit.common.data.SubmitRecord> getSubmitRecords()
```
Returns:
submit records stored during the most recent submit; only for changes that were actually submitted.

getChangeMessages

public com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.ChangeMessage> getChangeMessages()

Returns:: change messages by patch set, in chronological order.

getBaseComments

public com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchLineComment> getBaseComments()

Returns:: inline comments on each patchset's base (side == 0).

getPatchSetComments

public com.google.common.collect.ImmutableListMultimap<com.google.gerrit.reviewdb.client.PatchSet.Id,com.google.gerrit.reviewdb.client.PatchLineComment> getPatchSetComments()

Returns:: inline comments on each patchset (side == 1).

getRefName
```
protected String getRefName()
```
Specified by:

getRefName in class VersionedMetaData

Returns:
name of the reference storing this configuration.

onLoad
```
protected void onLoad()
               throws IOException,
                      org.eclipse.jgit.errors.ConfigInvalidException
```
Description copied from class: VersionedMetaData

Set up the metadata, parsing any state from the loaded revision.

Specified by:

onLoad in class VersionedMetaData

Throws:

IOException

org.eclipse.jgit.errors.ConfigInvalidException

onSave
```
protected boolean onSave(org.eclipse.jgit.lib.CommitBuilder commit)
```
Description copied from class: VersionedMetaData

Save any changes to the metadata in a commit.

Specified by:

onSave in class VersionedMetaData

Returns:
true if the commit should proceed, false to abort.

getProjectName
```
protected com.google.gerrit.reviewdb.client.Project.NameKey getProjectName()
```
Specified by:

getProjectName in class AbstractChangeNotes<ChangeNotes>

Returns:
the NameKey for the project where the notes should be stored, which is not necessarily the same as the change's project.

Class ChangeNotes

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gerrit.server.git.VersionedMetaData

Field Summary

Fields inherited from class com.google.gerrit.server.notedb.AbstractChangeNotes

Fields inherited from class com.google.gerrit.server.git.VersionedMetaData

Constructor Summary

Method Summary

Methods inherited from class com.google.gerrit.server.notedb.AbstractChangeNotes

Methods inherited from class com.google.gerrit.server.git.VersionedMetaData

Methods inherited from class java.lang.Object

Field Detail

MESSAGE_BY_TIME

PatchLineCommentComparator

Constructor Detail

ChangeNotes

Method Detail

parseException

parseIdent

getApprovals

getReviewers

getSubmitRecords

getChangeMessages

getBaseComments

getPatchSetComments

getRefName

onLoad

onSave

getProjectName