rocks.inspectit.releaseplugin

Class IssueUpdateBuilder

java.lang.Object

rocks.inspectit.releaseplugin.IssueUpdateBuilder

public class IssueUpdateBuilder
extends Object

Utility class for building the data sent to /ISSUE_KEY/ PUT requests to update issues. See the JRIA Rest API documentation for more information

Author:

Jonas Kunz

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	SUPPORTED_TYPES Currently supported types for serialization.

Constructor Summary

Constructors

Constructor and Description
IssueUpdateBuilder() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAffectedVersion(String versionName) Adds the given version to the list of affected versions.
void	addComment(String body) Adds the given comment.
void	addFieldValue(String fieldName, String fieldType, String value) Generic way of adding a value to an array field.
com.google.gson.JsonElement	getRequestData() Returns the data to send with the put - request for updating an issue.
void	removeAffectedVersion(String versionName) Removes the given version from the list of affected versions.
void	removeFieldValue(String fieldName, String fieldType, String value) Generic way of removing a value from an array field.
void	setArrayField(String fieldName, String fieldType, String... values) Generic way of setting (replacing) array fields.
void	setFieldValue(String fieldName, String fieldType, String value) Generic way of setting single-valued field values.

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTED_TYPES

public static final Set<String> SUPPORTED_TYPES

Currently supported types for serialization.

Constructor Detail

IssueUpdateBuilder

public IssueUpdateBuilder()

Constructor.

Method Detail

getRequestData

public com.google.gson.JsonElement getRequestData()

Returns the data to send with the put - request for updating an issue.

Returns:

the finished request

addAffectedVersion

public void addAffectedVersion(String versionName)

Adds the given version to the list of affected versions.

Parameters:

versionName - the name of the version to add.

addComment

public void addComment(String body)

Adds the given comment.

Parameters:

body - the body of the comment to add.

setFieldValue

public void setFieldValue(String fieldName,
                          String fieldType,
                          String value)

Generic way of setting single-valued field values. See SUPPORTED_TYPES for the supported field types.

Parameters:

fieldName - the name of the field

fieldType - the type of the field

value - the value to set

setArrayField

public void setArrayField(String fieldName,
                          String fieldType,
                          String... values)

Generic way of setting (replacing) array fields. See SUPPORTED_TYPES for the supported element types.

Parameters:

fieldName - the name of the field

fieldType - the type of the fields elements

values - the values to set

addFieldValue

public void addFieldValue(String fieldName,
                          String fieldType,
                          String value)

Generic way of adding a value to an array field. See SUPPORTED_TYPES for the supported element types.

Parameters:

fieldName - the name of the field

fieldType - the type of the fields elements

value - the value to add

removeFieldValue

public void removeFieldValue(String fieldName,
                             String fieldType,
                             String value)

Generic way of removing a value from an array field. See SUPPORTED_TYPES for the supported element types.

Parameters:

fieldName - the name of the field

fieldType - the type of the fields elements

value - the value to add

removeAffectedVersion

public void removeAffectedVersion(String versionName)

Removes the given version from the list of affected versions.

Parameters:

versionName - the name of the version to remove.