net.rcarz.jiraclient

Class Comment

java.lang.Object

net.rcarz.jiraclient.Resource

net.rcarz.jiraclient.Comment

public class Comment
extends Resource

Represents an issue comment.

Field Summary

Fields inherited from class net.rcarz.jiraclient.Resource

apirev, DEFAULT_API_REV, id, restclient, self

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Comment(RestClient restclient, net.sf.json.JSONObject json, String issueKey) Creates a comment from a JSON payload.

Method Summary

Modifier and Type	Method and Description
static Comment	get(RestClient restclient, String issue, String id) Retrieves the given comment record.
User	getAuthor()
String	getBody()
Date	getCreatedDate()
User	getUpdateAuthor()
Date	getUpdatedDate()
Visibility	getVisibility()
String	toString()
void	update(String body) Updates the comment body.
void	update(String body, String visType, String visName) Updates the comment body with limited visibility.

Methods inherited from class net.rcarz.jiraclient.Resource

getApiRev, getAuthUri, getBaseUri, getId, getSelf, getUrl, setApiRev

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Comment

protected Comment(RestClient restclient,
                  net.sf.json.JSONObject json,
                  String issueKey)

Creates a comment from a JSON payload.

Parameters:

restclient - REST client instance

json - JSON payload

Method Detail

getVisibility

public Visibility getVisibility()

get

public static Comment get(RestClient restclient,
                          String issue,
                          String id)
                   throws JiraException

Retrieves the given comment record.

Parameters:

restclient - REST client instance

issue - Internal JIRA ID of the associated issue

id - Internal JIRA ID of the comment

Returns:

a comment instance

Throws:

JiraException - when the retrieval fails

update

public void update(String body)
            throws JiraException

Updates the comment body.

Parameters:

issue - associated issue record

body - Comment text

Throws:

JiraException - when the comment update fails

update

public void update(String body,
                   String visType,
                   String visName)
            throws JiraException

Updates the comment body with limited visibility.

Parameters:

issue - associated issue record

body - Comment text

visType - Target audience type (role or group)

visName - Name of the role or group to limit visibility to

Throws:

JiraException - when the comment update fails

toString

public String toString()

Overrides:

toString in class Object

getAuthor

public User getAuthor()

getBody

public String getBody()

getCreatedDate

public Date getCreatedDate()

getUpdateAuthor

public User getUpdateAuthor()

getUpdatedDate

public Date getUpdatedDate()