com.atlassian.jira.issue.fields.rest.json

Interface WorklogBeanFactory

All Known Implementing Classes:

DefaultWorklogBeanFactory

@ExperimentalApi
public interface WorklogBeanFactory

This provides a simple, dependency-free, straight forward API to generating the JSON corresponding to a Worklog.

Since:

v7.0

Method Summary

Modifier and Type	Method and Description
WorklogJsonBean	createBean(Worklog worklog, ApplicationUser loggedInUser) Generate a bean suitable for serialisation by Jackson into JSON.
Iterable<WorklogJsonBean>	createBeans(Iterable<Worklog> worklogs, ApplicationUser loggedInUser) Generate beans suitable for serialisation by Jackson into JSON.

Method Detail

createBean

WorklogJsonBean createBean(Worklog worklog,
                           ApplicationUser loggedInUser)

Generate a bean suitable for serialisation by Jackson into JSON.

Parameters:

worklog - Worklog which would be used for creating bean.

loggedInUser - WorklogJsonBean will be created in the context of loggedInUser (i.e. hide email address if necessary)

Returns:

Bean suitable for serialisation by Jackson into JSON for given worklog

createBeans

Iterable<WorklogJsonBean> createBeans(Iterable<Worklog> worklogs,
                                      ApplicationUser loggedInUser)

Generate beans suitable for serialisation by Jackson into JSON.

Parameters:

worklogs - Worklogs which would be used for creating a collection of beans.

loggedInUser - WorklogJsonBean will be created in the context of loggedInUser (i.e. hide email address if necessary)

Returns:

Bean suitable for serialisation by Jackson into JSON for given worklog