MultiStringUpdater (hapi-jira 0.2.146 API)

com.adaptavist.hapi.cloud.jira.issues.delegates.MultiStringUpdater

```
abstract class MultiStringUpdater
extends java.lang.Object
```
Utility class for managing string-based multi-value fields in Jira Cloud, such as Labels or custom multi-select fields.
The MultiStringUpdater prepares operations to add, remove, replace, or clear string values in a multi-value field. It ensures that changes are tracked incrementally, allowing granular updates.

Supported Operations:
- add: Adds new string values to the field.
- remove: Removes specific string values from the field.
- set: Replaces all current values with the specified string values.
- clear: Clears all values in the field.
- replace: Replaces an existing string value with a new one (only if the old value exists).
Example Usage in Groovy with Issue Updates:
Suppose you want to update the Labels field of an issue:
```
Issues.getByKey("TEST-123").update {
     setLabels {
         add("new-label-1", "new-label-2")    // Add new labels
         remove("old-label-1")                // Remove a specific label
         replace("temp-label", "final-label") // Replace an existing label
     
 }
 }
```
Clearing all labels:
```
Issues.getByKey("TEST-123").update {
     setLabels {
         clear()  // Removes all labels from the issue
     
 }
 }
```
Replacing all existing labels:
```
Issues.getByKey("TEST-123").update {
     setLabels {
         set("final-label-1", "final-label-2")
     
 }
 }
```
Example Output from get()
After performing the operations, the list of changes may look like:
```
[
   [add: "new-label-1"],
   [add: "new-label-2"],
   [remove: "old-label-1"],
   [remove: "temp-label"],
   [add: "final-label"]
 ]
 
```
Notes:
- Use the replace method only when you know the value to replace exists. Otherwise, it has no effect.
- The add method does not check for duplicates — ensure unique values when necessary.

Field Summary

Fields
Modifiers	Name	Description
`protected java.util.List<java.util.Map>`	`operations`

Constructor Summary

Constructors
Constructor and description
`MultiStringUpdater(java.util.List<java.lang.String> items)` Creates a new `MultiStringUpdater` with the current field values.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`add(java.lang.String[] items)` Adds one or more string values to the field.
	`void`	`clear()` Clears all values from the field.
	`java.util.List`	`get()` Retrieves the list of operations to be applied to the field.
	`void`	`remove(java.lang.String[] items)` Removes one or more string values from the field.
	`void`	`replace(java.lang.String oldItem, java.lang.String newItem)` Replaces an existing string value with a new value, if the old value exists.
	`void`	`set(java.lang.String[] items)` Replaces all values in the field with the specified string values.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Field Detail
  - protected final java.util.List<java.util.Map> operations
- Constructor Detail
  - MultiStringUpdater(java.util.List<java.lang.String> items)
    
    Creates a new MultiStringUpdater with the current field values.
    Parameters:
    items - the existing items in the field
- Method Detail
  - void add(java.lang.String[] items)
    
    Adds one or more string values to the field.
    Parameters:
    items - the string values to add
  - void clear()
    
    Clears all values from the field.
  - java.util.List get()
    
    Retrieves the list of operations to be applied to the field.
    Returns:
    a list of operations, where each operation is represented as a java.util.Map
  - void remove(java.lang.String[] items)
    
    Removes one or more string values from the field.
    Parameters:
    items - the string values to remove
  - void replace(java.lang.String oldItem, java.lang.String newItem)
    
    Replaces an existing string value with a new value, if the old value exists.
    Parameters:
    oldItem - the value to be replaced
    newItem - the new value to add
  - void set(java.lang.String[] items)
    
    Replaces all values in the field with the specified string values.
    Parameters:
    items - the string values to set

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class MultiStringUpdater

Supported Operations:

Example Usage in Groovy with Issue Updates:

Example Output from get()

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final java.util.List<java.util.Map> operations

Constructor Detail

MultiStringUpdater(java.util.List<java.lang.String> items)

Method Detail

void add(java.lang.String[] items)

void clear()

java.util.List get()

void remove(java.lang.String[] items)

void replace(java.lang.String oldItem, java.lang.String newItem)

void set(java.lang.String[] items)