com.google.gerrit.reviewdb.client

Class Comment

java.lang.Object

com.google.gerrit.reviewdb.client.Comment

Direct Known Subclasses:

RobotComment

public class Comment
extends java.lang.Object

This class represents inline comments in NoteDb. This means it determines the JSON format for inline comments in the revision notes that NoteDb uses to persist inline comments.

Changing fields in this class changes the storage format of inline comments in NoteDb and may require a corresponding data migration (adding new optional fields is generally okay).

PatchLineComment also represents inline comments, but in ReviewDb. There are a few notable differences:

• PatchLineComment knows the comment status (published or draft). For comments in NoteDb the status is determined by the branch in which they are stored (published comments are stored in the change meta ref; draft comments are store in refs/draft-comments branches in All-Users). Hence Comment doesn't need to contain the status, but the status is implicitly known by where the comments are read from.
• PatchLineComment knows the change ID. For comments in NoteDb, the change ID is determined by the branch in which they are stored (the ref name contains the change ID). Hence Comment doesn't need to contain the change ID, but the change ID is implicitly known by where the comments are read from.

For all utility classes and middle layer functionality using Comment over PatchLineComment is preferred, as PatchLineComment will go away together with ReviewDb. This means Comment should be used everywhere and only for storing inline comment in ReviewDb a conversion to PatchLineComment is done. Converting Comments to PatchLineComments and vice verse is done by CommentsUtil#toPatchLineComments(Change.Id, PatchLineComment.Status, Iterable) and CommentsUtil#toComments(String, Iterable).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Comment.Identity
static class	Comment.Key
static class	Comment.Range

Field Summary

Fields

Modifier and Type	Field and Description
Comment.Identity	author
Comment.Key	key
boolean	legacyFormat Whether the comment was parsed from a JSON representation (false) or the legacy custom notes format (true).
int	lineNbr
java.lang.String	message
java.lang.String	parentUuid
Comment.Range	range
protected Comment.Identity	realAuthor
java.lang.String	revId
java.lang.String	serverId
short	side
java.lang.String	tag
boolean	unresolved
java.sql.Timestamp	writtenOn

Constructor Summary

Constructors

Constructor and Description
Comment(Comment.Key key, Account.Id author, java.sql.Timestamp writtenOn, short side, java.lang.String message, java.lang.String serverId, boolean unresolved)
Comment(Comment c)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
Comment.Identity	getRealAuthor()
int	hashCode()
void	setLineNbrAndRange(java.lang.Integer lineNbr, Comment.Range range)
void	setRange(CommentRange range)
void	setRealAuthor(Account.Id id)
void	setRevId(RevId revId)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

key

public Comment.Key key

lineNbr

public int lineNbr

author

public Comment.Identity author

realAuthor

protected Comment.Identity realAuthor

writtenOn

public java.sql.Timestamp writtenOn

side

public short side

message

public java.lang.String message

parentUuid

public java.lang.String parentUuid

range

public Comment.Range range

tag

public java.lang.String tag

revId

public java.lang.String revId

serverId

public java.lang.String serverId

unresolved

public boolean unresolved

legacyFormat

public transient boolean legacyFormat

Whether the comment was parsed from a JSON representation (false) or the legacy custom notes format (true).

Constructor Detail

Comment

public Comment(Comment c)

Comment

public Comment(Comment.Key key,
               Account.Id author,
               java.sql.Timestamp writtenOn,
               short side,
               java.lang.String message,
               java.lang.String serverId,
               boolean unresolved)

Method Detail

setLineNbrAndRange

public void setLineNbrAndRange(java.lang.Integer lineNbr,
                               Comment.Range range)

setRange

public void setRange(CommentRange range)

setRevId

public void setRevId(RevId revId)

setRealAuthor

public void setRealAuthor(Account.Id id)

getRealAuthor

public Comment.Identity getRealAuthor()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object