com.clxcommunications.xms.api

Class GroupCreate.Builder

java.lang.Object

com.clxcommunications.xms.api.GroupCreate.Builder

Enclosing class:

GroupCreate

public static final class GroupCreate.Builder
extends Object

A builder of group creation descriptions.

Method Summary

Modifier and Type	Method and Description
GroupCreate.Builder	addAllChildGroups(Iterable<? extends GroupId> elements) Adds elements to childGroups set.
GroupCreate.Builder	addAllMembers(Iterable<String> elements) Adds elements to members set.
GroupCreate.Builder	addAllTags(Iterable<String> elements) Adds elements to tags set.
GroupCreate.Builder	addChildGroup(GroupId... elements) Adds elements to childGroups set.
GroupCreate.Builder	addChildGroup(GroupId element) Adds one element to childGroups set.
GroupCreate.Builder	addMember(String... elements) Adds elements to members set.
GroupCreate.Builder	addMember(String element) Adds one element to members set.
GroupCreate.Builder	addTag(String... elements) Adds elements to tags set.
GroupCreate.Builder	addTag(String element) Adds one element to tags set.
GroupCreate.Builder	autoUpdate(AutoUpdate autoUpdate) Initializes the value for the autoUpdate attribute.
GroupCreate	build() Builds a new GroupCreate.
GroupCreate.Builder	childGroups(Iterable<? extends GroupId> elements) Sets or replaces all elements for childGroups set.
GroupCreate.Builder	members(Iterable<String> elements) Sets or replaces all elements for members set.
GroupCreate.Builder	name(String name) Initializes the value for the name attribute.
GroupCreate.Builder	tags(Iterable<String> elements) Sets or replaces all elements for tags set.
GroupCreate.Builder	using(GroupCreate instance) Fill a builder with attribute values from the provided GroupCreate instance.

Methods inherited from class java.lang.Object

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

Method Detail

using

public final GroupCreate.Builder using(GroupCreate instance)

Fill a builder with attribute values from the provided GroupCreate 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 GroupCreate.Builder name(@Nullable
                                      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

addMember

public final GroupCreate.Builder addMember(String element)

Adds one element to members set.

Parameters:

element - A members element

Returns:

this builder for use in a chained invocation

addMember

public final GroupCreate.Builder addMember(String... elements)

Adds elements to members set.

Parameters:

elements - An array of members elements

Returns:

this builder for use in a chained invocation

members

public final GroupCreate.Builder members(Iterable<String> elements)

Sets or replaces all elements for members set.

Parameters:

elements - An iterable of members elements

Returns:

this builder for use in a chained invocation

addAllMembers

public final GroupCreate.Builder addAllMembers(Iterable<String> elements)

Adds elements to members set.

Parameters:

elements - An iterable of members elements

Returns:

this builder for use in a chained invocation

addChildGroup

public final GroupCreate.Builder addChildGroup(GroupId element)

Adds one element to childGroups set.

Parameters:

element - A childGroups element

Returns:

this builder for use in a chained invocation

addChildGroup

public final GroupCreate.Builder addChildGroup(GroupId... elements)

Adds elements to childGroups set.

Parameters:

elements - An array of childGroups elements

Returns:

this builder for use in a chained invocation

childGroups

public final GroupCreate.Builder childGroups(Iterable<? extends GroupId> elements)

Sets or replaces all elements for childGroups set.

Parameters:

elements - An iterable of childGroups elements

Returns:

this builder for use in a chained invocation

addAllChildGroups

public final GroupCreate.Builder addAllChildGroups(Iterable<? extends GroupId> elements)

Adds elements to childGroups set.

Parameters:

elements - An iterable of childGroups elements

Returns:

this builder for use in a chained invocation

autoUpdate

public final GroupCreate.Builder autoUpdate(@Nullable
                                            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

addTag

public final GroupCreate.Builder addTag(String element)

Adds one element to tags set.

Parameters:

element - A tags element

Returns:

this builder for use in a chained invocation

addTag

public final GroupCreate.Builder addTag(String... elements)

Adds elements to tags set.

Parameters:

elements - An array of tags elements

Returns:

this builder for use in a chained invocation

tags

public final GroupCreate.Builder tags(Iterable<String> elements)

Sets or replaces all elements for tags set.

Parameters:

elements - An iterable of tags elements

Returns:

this builder for use in a chained invocation

addAllTags

public final GroupCreate.Builder addAllTags(Iterable<String> elements)

Adds elements to tags set.

Parameters:

elements - An iterable of tags elements

Returns:

this builder for use in a chained invocation

build

public GroupCreate build()

Builds a new GroupCreate.

Returns:

An immutable instance of GroupCreate

Throws:

IllegalStateException - if any required attributes are missing