GroupUpdate.Builder (SDK for CLX XMS 1.0.2 API)

java.lang.Object
- com.clxcommunications.xms.api.GroupUpdate.Builder

Enclosing class:: GroupUpdate

public static class GroupUpdate.Builder
extends Object

A builder of group updates.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GroupUpdate.Builder`	`addAllChildGroupInsertions(Iterable<? extends GroupId> elements)` Adds elements to `childGroupInsertions` set.
`GroupUpdate.Builder`	`addAllChildGroupRemovals(Iterable<? extends GroupId> elements)` Adds elements to `childGroupRemovals` set.
`GroupUpdate.Builder`	`addAllMemberInsertions(Iterable<String> elements)` Adds elements to `memberInsertions` set.
`GroupUpdate.Builder`	`addAllMemberRemovals(Iterable<String> elements)` Adds elements to `memberRemovals` set.
`GroupUpdate.Builder`	`addChildGroupInsertion(GroupId... elements)` Adds elements to `childGroupInsertions` set.
`GroupUpdate.Builder`	`addChildGroupInsertion(GroupId element)` Adds one element to `childGroupInsertions` set.
`GroupUpdate.Builder`	`addChildGroupRemoval(GroupId... elements)` Adds elements to `childGroupRemovals` set.
`GroupUpdate.Builder`	`addChildGroupRemoval(GroupId element)` Adds one element to `childGroupRemovals` set.
`GroupUpdate.Builder`	`addFromGroup(GroupId addFromGroup)` Initializes the value for the `addFromGroup` attribute.
`GroupUpdate.Builder`	`addMemberInsertion(String... elements)` Adds elements to `memberInsertions` set.
`GroupUpdate.Builder`	`addMemberInsertion(String element)` Adds one element to `memberInsertions` set.
`GroupUpdate.Builder`	`addMemberRemoval(String... elements)` Adds elements to `memberRemovals` set.
`GroupUpdate.Builder`	`addMemberRemoval(String element)` Adds one element to `memberRemovals` set.
`GroupUpdate.Builder`	`autoUpdate(AutoUpdate autoUpdate)` Updates the group auto update to the one given.
`GroupUpdate.Builder`	`autoUpdate(UpdateValue<AutoUpdate> autoUpdate)` Initializes the value for the `autoUpdate` attribute.
`GroupUpdate`	`build()` Builds a new `GroupUpdate`.
`GroupUpdate.Builder`	`childGroupInsertions(Iterable<? extends GroupId> elements)` Sets or replaces all elements for `childGroupInsertions` set.
`GroupUpdate.Builder`	`childGroupRemovals(Iterable<? extends GroupId> elements)` Sets or replaces all elements for `childGroupRemovals` set.
`GroupUpdate.Builder`	`memberInsertions(Iterable<String> elements)` Sets or replaces all elements for `memberInsertions` set.
`GroupUpdate.Builder`	`memberRemovals(Iterable<String> elements)` Sets or replaces all elements for `memberRemovals` set.
`GroupUpdate.Builder`	`name(String name)` Updates the group name to the given name.
`GroupUpdate.Builder`	`name(UpdateValue<String> name)` Initializes the value for the `name` attribute.
`GroupUpdate.Builder`	`removeFromGroup(GroupId removeFromGroup)` Initializes the value for the `removeFromGroup` attribute.
`GroupUpdate.Builder`	`unsetAutoUpdate()` Unsets the group auto update setting.
`GroupUpdate.Builder`	`unsetName()` Unsets the name of the group.
`GroupUpdate.Builder`	`using(GroupUpdate instance)` Fill a builder with attribute values from the provided `GroupUpdate` instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - unsetName
```
public GroupUpdate.Builder unsetName()
```
    Unsets the name of the group.
    
    Returns:
    
    this builder for use in a chained invocation
  - name
```
public GroupUpdate.Builder name(String name)
```
    Updates the group name to the given name.
    
    Parameters:
    
    name - the new group name
    
    Returns:
    
    this builder for use in a chained invocation
  - unsetAutoUpdate
```
public GroupUpdate.Builder unsetAutoUpdate()
```
    Unsets the group auto update setting.
    
    Returns:
    
    this builder for use in a chained invocation
  - autoUpdate
```
public GroupUpdate.Builder autoUpdate(AutoUpdate autoUpdate)
```
    Updates the group auto update to the one given.
    
    Parameters:
    
    autoUpdate - the new auto update setting
    
    Returns:
    
    this builder for use in a chained invocation
  - using
```
public final GroupUpdate.Builder using(GroupUpdate instance)
```
    Fill a builder with attribute values from the provided GroupUpdate instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.
    
    Parameters:
    
    instance - The instance from which to copy values
    
    Returns:
    
    this builder for use in a chained invocation
  - name
```
public final GroupUpdate.Builder name(@Nullable
                                      UpdateValue<String> name)
```
    Initializes the value for the name attribute.
    
    Parameters:
    
    name - The value for name (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - addMemberInsertion
```
public final GroupUpdate.Builder addMemberInsertion(String element)
```
    Adds one element to memberInsertions set.
    
    Parameters:
    
    element - A memberInsertions element
    
    Returns:
    
    this builder for use in a chained invocation
  - addMemberInsertion
```
public final GroupUpdate.Builder addMemberInsertion(String... elements)
```
    Adds elements to memberInsertions set.
    
    Parameters:
    
    elements - An array of memberInsertions elements
    
    Returns:
    
    this builder for use in a chained invocation
  - memberInsertions
```
public final GroupUpdate.Builder memberInsertions(Iterable<String> elements)
```
    Sets or replaces all elements for memberInsertions set.
    
    Parameters:
    
    elements - An iterable of memberInsertions elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllMemberInsertions
```
public final GroupUpdate.Builder addAllMemberInsertions(Iterable<String> elements)
```
    Adds elements to memberInsertions set.
    
    Parameters:
    
    elements - An iterable of memberInsertions elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addMemberRemoval
```
public final GroupUpdate.Builder addMemberRemoval(String element)
```
    Adds one element to memberRemovals set.
    
    Parameters:
    
    element - A memberRemovals element
    
    Returns:
    
    this builder for use in a chained invocation
  - addMemberRemoval
```
public final GroupUpdate.Builder addMemberRemoval(String... elements)
```
    Adds elements to memberRemovals set.
    
    Parameters:
    
    elements - An array of memberRemovals elements
    
    Returns:
    
    this builder for use in a chained invocation
  - memberRemovals
```
public final GroupUpdate.Builder memberRemovals(Iterable<String> elements)
```
    Sets or replaces all elements for memberRemovals set.
    
    Parameters:
    
    elements - An iterable of memberRemovals elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllMemberRemovals
```
public final GroupUpdate.Builder addAllMemberRemovals(Iterable<String> elements)
```
    Adds elements to memberRemovals set.
    
    Parameters:
    
    elements - An iterable of memberRemovals elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addChildGroupInsertion
```
public final GroupUpdate.Builder addChildGroupInsertion(GroupId element)
```
    Adds one element to childGroupInsertions set.
    
    Parameters:
    
    element - A childGroupInsertions element
    
    Returns:
    
    this builder for use in a chained invocation
  - addChildGroupInsertion
```
public final GroupUpdate.Builder addChildGroupInsertion(GroupId... elements)
```
    Adds elements to childGroupInsertions set.
    
    Parameters:
    
    elements - An array of childGroupInsertions elements
    
    Returns:
    
    this builder for use in a chained invocation
  - childGroupInsertions
```
public final GroupUpdate.Builder childGroupInsertions(Iterable<? extends GroupId> elements)
```
    Sets or replaces all elements for childGroupInsertions set.
    
    Parameters:
    
    elements - An iterable of childGroupInsertions elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllChildGroupInsertions
```
public final GroupUpdate.Builder addAllChildGroupInsertions(Iterable<? extends GroupId> elements)
```
    Adds elements to childGroupInsertions set.
    
    Parameters:
    
    elements - An iterable of childGroupInsertions elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addChildGroupRemoval
```
public final GroupUpdate.Builder addChildGroupRemoval(GroupId element)
```
    Adds one element to childGroupRemovals set.
    
    Parameters:
    
    element - A childGroupRemovals element
    
    Returns:
    
    this builder for use in a chained invocation
  - addChildGroupRemoval
```
public final GroupUpdate.Builder addChildGroupRemoval(GroupId... elements)
```
    Adds elements to childGroupRemovals set.
    
    Parameters:
    
    elements - An array of childGroupRemovals elements
    
    Returns:
    
    this builder for use in a chained invocation
  - childGroupRemovals
```
public final GroupUpdate.Builder childGroupRemovals(Iterable<? extends GroupId> elements)
```
    Sets or replaces all elements for childGroupRemovals set.
    
    Parameters:
    
    elements - An iterable of childGroupRemovals elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllChildGroupRemovals
```
public final GroupUpdate.Builder addAllChildGroupRemovals(Iterable<? extends GroupId> elements)
```
    Adds elements to childGroupRemovals set.
    
    Parameters:
    
    elements - An iterable of childGroupRemovals elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addFromGroup
```
public final GroupUpdate.Builder addFromGroup(@Nullable
                                              GroupId addFromGroup)
```
    Initializes the value for the addFromGroup attribute.
    
    Parameters:
    
    addFromGroup - The value for addFromGroup (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - removeFromGroup
```
public final GroupUpdate.Builder removeFromGroup(@Nullable
                                                 GroupId removeFromGroup)
```
    Initializes the value for the removeFromGroup attribute.
    
    Parameters:
    
    removeFromGroup - The value for removeFromGroup (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - autoUpdate
```
public final GroupUpdate.Builder autoUpdate(@Nullable
                                            UpdateValue<AutoUpdate> autoUpdate)
```
    Initializes the value for the autoUpdate attribute.
    
    Parameters:
    
    autoUpdate - The value for autoUpdate (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - build
```
public GroupUpdate build()
```
    Builds a new GroupUpdate.
    
    Returns:
    
    An immutable instance of GroupUpdate
    
    Throws:
    
    IllegalStateException - if any required attributes are missing

Class GroupUpdate.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

unsetName

name

unsetAutoUpdate

autoUpdate

using

name

addMemberInsertion

addMemberInsertion

memberInsertions

addAllMemberInsertions

addMemberRemoval

addMemberRemoval

memberRemovals

addAllMemberRemovals

addChildGroupInsertion

addChildGroupInsertion

childGroupInsertions

addAllChildGroupInsertions

addChildGroupRemoval

addChildGroupRemoval

childGroupRemovals

addAllChildGroupRemovals

addFromGroup

removeFromGroup

autoUpdate

build