com.clxcommunications.xms

Class GroupFilter.Builder

java.lang.Object

com.clxcommunications.xms.GroupFilter.Builder

Enclosing class:

GroupFilter

public static class GroupFilter.Builder
extends Object

A builder of group filters.

Method Summary

Modifier and Type	Method and Description
GroupFilter.Builder	addAllTags(Iterable<String> elements) Adds elements to tags set.
GroupFilter.Builder	addTag(String... elements) Adds elements to tags set.
GroupFilter.Builder	addTag(String element) Adds one element to tags set.
GroupFilter	build() Builds a new GroupFilter.
GroupFilter.Builder	pageSize(int pageSize) Initializes the value for the pageSize attribute.
GroupFilter.Builder	tags(Iterable<String> elements) Sets or replaces all elements for tags set.
GroupFilter.Builder	using(GroupFilter instance) Fill a builder with attribute values from the provided GroupFilter instance.

Methods inherited from class java.lang.Object

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

Method Detail

using

public final GroupFilter.Builder using(GroupFilter instance)

Fill a builder with attribute values from the provided GroupFilter 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

pageSize

public final GroupFilter.Builder pageSize(int pageSize)

Initializes the value for the pageSize attribute.

If not set, this attribute will have a default value as returned by the initializer of pageSize.

Parameters:

pageSize - The value for pageSize

Returns:

this builder for use in a chained invocation

addTag

public final GroupFilter.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 GroupFilter.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 GroupFilter.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 GroupFilter.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 GroupFilter build()

Builds a new GroupFilter.

Returns:

An immutable instance of GroupFilter

Throws:

IllegalStateException - if any required attributes are missing