MultiOptionNameUpdater (hapi-jira 0.2.146 API)

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

```
class MultiOptionNameUpdater
extends java.lang.Object
```
Utility class for managing multi-option fields in Jira Cloud, such as Components, Versions, or Labels.
The MultiOptionNameUpdater prepares operations to add, remove, replace, or clear options in multi-option fields. It supports operations using both option names and IDs. Note: Adding an option does not create new entries; the specified options must already exist in Jira.

Supported Operations:
- add: Add options by name or ID (options must already exist).
- remove: Remove options by name or ID.
- set: Replace all options with the specified names or IDs.
- clear: Remove all options.
Example Usage in Groovy with Issue Updates:
Suppose you want to remove specific Components from an issue in Jira Cloud using their IDs:
```
Issues.getByKey("TEST-123").update {
     setComponents {
         remove(1001L, 1002L)  // Removes Components with IDs 1001 and 1002
     
 }
}
```
To add or set Components by their names:
```
Issues.getByKey("TEST-123").update {
     setComponents {
         add("Backend Module", "Frontend Module")
         set("Core Module", "API Module")  // Replaces all Components with the specified ones
     
 }
}
```
Clearing all components:
```
Issues.getByKey("TEST-123").update {
     setComponents {
         clear()  // Removes all Components from the issue
     
 }
}
```
Example Output from get()
The operations list generated by the updater can look like this:
```
[
   [remove: [id: "1001"]],
   [remove: [id: "1002"]],
   [add: [name: "Backend Module"]],
   [set: [[name: "Core Module"], [name: "API Module"]]],
   [set: []]
 ]
```

Field Summary

Fields
Modifiers	Name	Description
`protected java.util.List<java.util.Map>`	`operations`	A list of operations to be applied to the multi-option field.

Constructor Summary

Constructors
Constructor and description
`MultiOptionNameUpdater()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`add(java.lang.String[] items)` Adds existing options to the field using their names.
	`void`	`add(java.lang.Long[] items)` Adds existing options to the field using their IDs.
	`void`	`clear()` Clears all options from the field.
	`java.util.List<java.util.Map>`	`get()` Retrieves the list of operations to be applied to the multi-option field.
	`void`	`remove(java.lang.String[] items)` Removes options from the field using their names.
	`void`	`remove(java.lang.Long[] items)` Removes options from the field using their IDs.
	`void`	`set(java.lang.String[] items)` Replaces all options in the field with the specified names.
	`void`	`set(java.lang.Long[] items)` Replaces all options in the field with the specified IDs.

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
    
    A list of operations to be applied to the multi-option field.
- Constructor Detail
  - MultiOptionNameUpdater()
- Method Detail
  - void add(java.lang.String[] items)
    
    Adds existing options to the field using their names.
    Parameters:
    items - one or more option names to add
  - void add(java.lang.Long[] items)
    
    Adds existing options to the field using their IDs.
    Parameters:
    items - one or more option IDs to add
  - void clear()
    
    Clears all options from the field.
  - java.util.List<java.util.Map> get()
    
    Retrieves the list of operations to be applied to the multi-option field.
    Returns:
    a list of operations, where each operation is represented as a java.util.Map
  - void remove(java.lang.String[] items)
    
    Removes options from the field using their names.
    Parameters:
    items - one or more option names to remove
  - void remove(java.lang.Long[] items)
    
    Removes options from the field using their IDs.
    Parameters:
    items - one or more option IDs to remove
  - void set(java.lang.String[] items)
    
    Replaces all options in the field with the specified names.
    Parameters:
    items - one or more option names to set
  - void set(java.lang.Long[] items)
    
    Replaces all options in the field with the specified IDs.
    Parameters:
    items - one or more option IDs to set

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class MultiOptionNameUpdater

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

MultiOptionNameUpdater()

Method Detail

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

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

void clear()

java.util.List<java.util.Map> get()

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

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

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

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