Package com.google.gerrit.entities

Class Comment

java.lang.Object

com.google.gerrit.entities.Comment

Direct Known Subclasses:

HumanComment, RobotComment

public abstract class Comment
extends Object

This class is a base class that can be extended by the different types of inline comment entities.

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

Consider updating getCommentFieldApproximateSize() when adding/changing fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Comment.Identity
static class	Comment.Key
static class	Comment.Range	The Range class defines continuous range of character.
static class	Comment.Status

Field Summary

Fields

Modifier and Type	Field	Description
Comment.Identity	author
Comment.Key	key
int	lineNbr	The line number (1-based) to which the comment refers, or 0 for a file comment.
String	message
String	parentUuid
Comment.Range	range
protected Comment.Identity	realAuthor
String	serverId
short	side
String	tag
Timestamp	writtenOn

Constructor Summary

Constructors

Constructor	Description
Comment(Comment c)
Comment(Comment.Key key, Account.Id author, Instant writtenOn, short side, String message, String serverId)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
abstract int	getApproximateSize()
protected int	getCommentFieldApproximateSize()	Returns the comment's approximate size.
org.eclipse.jgit.lib.ObjectId	getCommitId()
Comment.Identity	getRealAuthor()
int	hashCode()
void	setCommitId(org.eclipse.jgit.lib.AnyObjectId commitId)
void	setLineNbrAndRange(Integer lineNbr, Comment.Range range)
void	setRange(CommentRange range)
void	setRealAuthor(Account.Id id)
void	setWrittenOn(Instant writtenOn)
String	toString()
protected com.google.common.base.MoreObjects.ToStringHelper	toStringHelper()

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

The line number (1-based) to which the comment refers, or 0 for a file comment.

author

public Comment.Identity author

realAuthor

protected Comment.Identity realAuthor

writtenOn

public Timestamp writtenOn

side

public short side

message

public String message

parentUuid

public String parentUuid

range

public Comment.Range range

tag

public String tag

serverId

public String serverId

Constructor Detail

Comment

public Comment(Comment c)

Comment

public Comment(Comment.Key key,
               Account.Id author,
               Instant writtenOn,
               short side,
               String message,
               String serverId)

Method Detail

setWrittenOn

public void setWrittenOn(Instant writtenOn)

setLineNbrAndRange

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

setRange

public void setRange(CommentRange range)

getCommitId

public org.eclipse.jgit.lib.ObjectId getCommitId()

setCommitId

public void setCommitId(org.eclipse.jgit.lib.AnyObjectId commitId)

setRealAuthor

public void setRealAuthor(Account.Id id)

getRealAuthor

public Comment.Identity getRealAuthor()

getCommentFieldApproximateSize

protected int getCommentFieldApproximateSize()

Returns the comment's approximate size. This is used to enforce size limits and should therefore include all unbounded fields (e.g. String-s).

getApproximateSize

public abstract int getApproximateSize()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringHelper

protected com.google.common.base.MoreObjects.ToStringHelper toStringHelper()