CommentSender (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.mail.OutgoingEmail
- - com.google.gerrit.server.mail.NotificationEmail
  - - com.google.gerrit.server.mail.ChangeEmail
    - - com.google.gerrit.server.mail.ReplyToChangeSender
      - com.google.gerrit.server.mail.CommentSender

```
public class CommentSender
extends ReplyToChangeSender
```
Send comments, after the author of them hit used Publish Comments in the UI.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CommentSender.Factory

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CommentSender.Factory`

Field Summary
- Fields inherited from class com.google.gerrit.server.mail.ChangeEmail
  authors, change, changeData, changeMessage, emailOnlyAuthors, patchSet, patchSetInfo, projectState, timestamp
- Fields inherited from class com.google.gerrit.server.mail.NotificationEmail
  branch
- Fields inherited from class com.google.gerrit.server.mail.OutgoingEmail
  args, fromId, messageClass, notify, velocityContext

Constructor Summary

Constructors
Constructor and Description
`CommentSender(EmailArguments ea, PatchLineCommentsUtil plcUtil, com.google.gerrit.reviewdb.client.Project.NameKey project, com.google.gerrit.reviewdb.client.Change.Id id)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`formatChange()` Format the message body by calling `OutgoingEmail.appendText(String)`.
`void`	`formatFooter()` Format the message footer by calling `OutgoingEmail.appendText(String)`.
`String`	`getInlineComments()`
`String`	`getInlineComments(int lines)`
`boolean`	`hasInlineComments()`
`protected void`	`init()` Setup the message headers and envelope (TO, CC, BCC).
`void`	`setPatchLineComments(List<com.google.gerrit.reviewdb.client.PatchLineComment> plc)`

Methods inherited from class com.google.gerrit.server.mail.ChangeEmail
add, bccStarredBy, ccAllApprovals, ccExistingReviewers, format, formatChangeDetail, formatCoverLetter, getAuthors, getChangeDetail, getChangeMessageThreadId, getChangeUrl, getCoverLetter, getIncludeDiff, getPatchList, getProjectOwners, getProjectState, getUnifiedDiff, getWatchers, isVisibleTo, newChangeData, rcptToAuthors, setChangeMessage, setChangeMessage, setFrom, setPatchSet, setPatchSet, setupVelocityContext

Methods inherited from class com.google.gerrit.server.mail.NotificationEmail
add, getListId, getSshHost, includeWatchers

Methods inherited from class com.google.gerrit.server.mail.OutgoingEmail
add, add, add, appendText, getFromLine, getGerritHost, getGerritUrl, getNameEmailFor, getNameFor, getSettingsUrl, getUserNameEmailFor, joinStrings, joinStrings, removeUser, send, setHeader, setHeader, setNotify, setVHeader, shouldSendMessage, velocify, velocifyFile

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

Constructor Detail

CommentSender

@Inject
public CommentSender(EmailArguments ea,
                    PatchLineCommentsUtil plcUtil,
                    com.google.gerrit.reviewdb.client.Project.NameKey project,
                    com.google.gerrit.reviewdb.client.Change.Id id)
              throws com.google.gwtorm.server.OrmException

Throws:: com.google.gwtorm.server.OrmException

Method Detail
- setPatchLineComments
```
public void setPatchLineComments(List<com.google.gerrit.reviewdb.client.PatchLineComment> plc)
                          throws com.google.gwtorm.server.OrmException
```
  Throws:
  
  com.google.gwtorm.server.OrmException
- init
```
protected void init()
             throws com.google.gerrit.common.errors.EmailException
```
  Description copied from class: ChangeEmail
  
  Setup the message headers and envelope (TO, CC, BCC).
  
  Overrides:
  
  init in class ReplyToChangeSender
  
  Throws:
  
  com.google.gerrit.common.errors.EmailException - if an error occurred.
- formatChange
```
public void formatChange()
                  throws com.google.gerrit.common.errors.EmailException
```
  Description copied from class: ChangeEmail
  
  Format the message body by calling OutgoingEmail.appendText(String).
  
  Specified by:
  
  formatChange in class ChangeEmail
  
  Throws:
  
  com.google.gerrit.common.errors.EmailException
- formatFooter
```
public void formatFooter()
                  throws com.google.gerrit.common.errors.EmailException
```
  Description copied from class: ChangeEmail
  
  Format the message footer by calling OutgoingEmail.appendText(String).
  
  Overrides:
  
  formatFooter in class ChangeEmail
  
  Throws:
  
  com.google.gerrit.common.errors.EmailException - if an error occurred.
- hasInlineComments
```
public boolean hasInlineComments()
```
- getInlineComments
```
public String getInlineComments()
```
- getInlineComments
```
public String getInlineComments(int lines)
```

Class CommentSender

Nested Class Summary

Field Summary

Fields inherited from class com.google.gerrit.server.mail.ChangeEmail

Fields inherited from class com.google.gerrit.server.mail.NotificationEmail

Fields inherited from class com.google.gerrit.server.mail.OutgoingEmail

Constructor Summary

Method Summary

Methods inherited from class com.google.gerrit.server.mail.ChangeEmail

Methods inherited from class com.google.gerrit.server.mail.NotificationEmail

Methods inherited from class com.google.gerrit.server.mail.OutgoingEmail

Methods inherited from class java.lang.Object

Constructor Detail

CommentSender

Method Detail

setPatchLineComments

init

formatChange

formatFooter

hasInlineComments

getInlineComments

getInlineComments