BoxComment (Box Java SDK)

Object
- BoxResource
- - BoxComment

```
@BoxResourceType(value="comment")
public class BoxComment
extends BoxResource
```
Represents a comment on a file. Comments can be added directly to a file or they can be created as replies to other comments.
Unless otherwise noted, the methods in this class can throw an unchecked BoxAPIException (unchecked meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error handling for errors related to the Box REST API, you should capture this exception explicitly.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class BoxComment.Info
Contains information about a BoxComment.

Field Summary

Fields
Modifier and Type Field and Description

static URLTemplate ADD_COMMENT_URL_TEMPLATE
Add Comment URL Template.

static URLTemplate COMMENT_URL_TEMPLATE
Comment URL Template.

Constructor Summary

Constructors
Constructor and Description

BoxComment(BoxAPIConnection api, String id)
Constructs a BoxComment for a comment with a given ID.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BoxComment.Info`	`changeMessage(String newMessage)` Changes the message of this comment.
`void`	`delete()` Deletes this comment.
`BoxComment.Info`	`getInfo()` Gets information about this comment.
`BoxComment.Info`	`reply(String message)` Replies to this comment with another message.

Methods inherited from class BoxResource
equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ADD_COMMENT_URL_TEMPLATE
```
public static final URLTemplate ADD_COMMENT_URL_TEMPLATE
```
    Add Comment URL Template.
  - COMMENT_URL_TEMPLATE
```
public static final URLTemplate COMMENT_URL_TEMPLATE
```
    Comment URL Template.
- Constructor Detail
  - BoxComment
```
public BoxComment(BoxAPIConnection api,
                  String id)
```
    Constructs a BoxComment for a comment with a given ID.
    
    Parameters:
    
    api - the API connection to be used with the comment.
    
    id - the ID of the comment.
- Method Detail
  - getInfo
```
public BoxComment.Info getInfo()
```
    Gets information about this comment.
    
    Returns:
    
    info about this comment.
  - changeMessage
```
public BoxComment.Info changeMessage(String newMessage)
```
    Changes the message of this comment.
    
    Parameters:
    
    newMessage - the new message for this comment.
    
    Returns:
    
    updated info about this comment.
  - reply
```
public BoxComment.Info reply(String message)
```
    Replies to this comment with another message.
    
    Parameters:
    
    message - the message for the reply.
    
    Returns:
    
    info about the newly created reply comment.
  - delete
```
public void delete()
```
    Deletes this comment.