DraftCommentNotes (Gerrit Review Plugin API Documentation)

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

```
public class DraftCommentNotes
extends AbstractChangeNotes<DraftCommentNotes>
```
View of the draft comments for a single Change based on the log of its drafts branch.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DraftCommentNotes.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`	`DraftCommentNotes.Factory`

Field Summary
- Fields inherited from class com.google.gerrit.server.notedb.AbstractChangeNotes
  migration, repoManager
- Fields inherited from class com.google.gerrit.server.git.VersionedMetaData
  inserter, newTree, reader

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`containsComment(com.google.gerrit.reviewdb.client.PatchLineComment c)`
`com.google.gerrit.reviewdb.client.Account.Id`	`getAuthor()`
`com.google.common.collect.Table<com.google.gerrit.reviewdb.client.PatchSet.Id,String,com.google.gerrit.reviewdb.client.PatchLineComment>`	`getDraftBaseComments()`
`com.google.common.collect.Table<com.google.gerrit.reviewdb.client.PatchSet.Id,String,com.google.gerrit.reviewdb.client.PatchLineComment>`	`getDraftPsComments()`
`org.eclipse.jgit.notes.NoteMap`	`getNoteMap()`
`protected com.google.gerrit.reviewdb.client.Project.NameKey`	`getProjectName()`
`protected String`	`getRefName()`
`protected void`	`loadDefaults()` Load default values for any instance variables when notedb is disabled.
`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.

Methods inherited from class com.google.gerrit.server.notedb.AbstractChangeNotes
getChangeId, load, loadRevision, 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

- Method Detail
  - getNoteMap
```
public org.eclipse.jgit.notes.NoteMap getNoteMap()
```
  - getAuthor
```
public com.google.gerrit.reviewdb.client.Account.Id getAuthor()
```
  - getDraftBaseComments
```
public com.google.common.collect.Table<com.google.gerrit.reviewdb.client.PatchSet.Id,String,com.google.gerrit.reviewdb.client.PatchLineComment> getDraftBaseComments()
```
    Returns:
    a defensive copy of the table containing all draft comments on this change with side == 0. The row key is the comment's PatchSet.Id, the column key is the comment's UUID, and the value is the comment.
  - getDraftPsComments
```
public com.google.common.collect.Table<com.google.gerrit.reviewdb.client.PatchSet.Id,String,com.google.gerrit.reviewdb.client.PatchLineComment> getDraftPsComments()
```
    Returns:
    a defensive copy of the table containing all draft comments on this change with side == 1. The row key is the comment's PatchSet.Id, the column key is the comment's UUID, and the value is the comment.
  - containsComment
```
public boolean containsComment(com.google.gerrit.reviewdb.client.PatchLineComment c)
```
  - 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)
                  throws IOException,
                         org.eclipse.jgit.errors.ConfigInvalidException
```
    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.
    
    Throws:
    
    IOException
    
    org.eclipse.jgit.errors.ConfigInvalidException
  - loadDefaults
```
protected void loadDefaults()
```
    Description copied from class: AbstractChangeNotes
    
    Load default values for any instance variables when notedb is disabled.
    
    Specified by:
    
    loadDefaults in class AbstractChangeNotes<DraftCommentNotes>
  - getProjectName
```
protected com.google.gerrit.reviewdb.client.Project.NameKey getProjectName()
```
    Specified by:
    
    getProjectName in class AbstractChangeNotes<DraftCommentNotes>
    
    Returns:
    the NameKey for the project where the notes should be stored, which is not necessarily the same as the change's project.

Class DraftCommentNotes

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

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

Method Detail

getNoteMap

getAuthor

getDraftBaseComments

getDraftPsComments

containsComment

getRefName

onLoad

onSave

loadDefaults

getProjectName