com.clxcommunications.xms.api

Class PagedGroupResult.Builder

java.lang.Object

com.clxcommunications.xms.api.PagedGroupResult.Builder

Enclosing class:

PagedGroupResult

public static class PagedGroupResult.Builder
extends Object

A builder of group result pages.

Method Summary

Modifier and Type	Method and Description
PagedGroupResult.Builder	addAllContent(Iterable<? extends GroupResult> elements) Adds elements to content list.
PagedGroupResult.Builder	addContent(GroupResult... elements) Adds elements to content list.
PagedGroupResult.Builder	addContent(GroupResult element) Adds one element to content list.
PagedGroupResult	build() Builds a new PagedGroupResult.
PagedGroupResult.Builder	content(Iterable<? extends GroupResult> elements) Sets or replaces all elements for content list.
PagedGroupResult.Builder	page(int page) Initializes the value for the page attribute.
PagedGroupResult.Builder	size(int size) Initializes the value for the size attribute.
PagedGroupResult.Builder	totalSize(int totalSize) Initializes the value for the totalSize attribute.
PagedGroupResult.Builder	using(PagedGroupResult instance) Fill a builder with attribute values from the provided PagedGroupResult instance.

Methods inherited from class java.lang.Object

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

Method Detail

using

public final PagedGroupResult.Builder using(PagedGroupResult instance)

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

addContent

public final PagedGroupResult.Builder addContent(GroupResult element)

Adds one element to content list.

Parameters:

element - A content element

Returns:

this builder for use in a chained invocation

addContent

public final PagedGroupResult.Builder addContent(GroupResult... elements)

Adds elements to content list.

Parameters:

elements - An array of content elements

Returns:

this builder for use in a chained invocation

content

public final PagedGroupResult.Builder content(Iterable<? extends GroupResult> elements)

Sets or replaces all elements for content list.

Parameters:

elements - An iterable of content elements

Returns:

this builder for use in a chained invocation

addAllContent

public final PagedGroupResult.Builder addAllContent(Iterable<? extends GroupResult> elements)

Adds elements to content list.

Parameters:

elements - An iterable of content elements

Returns:

this builder for use in a chained invocation

page

public final PagedGroupResult.Builder page(int page)

Initializes the value for the page attribute.

Parameters:

page - The value for page

Returns:

this builder for use in a chained invocation

size

public final PagedGroupResult.Builder size(int size)

Initializes the value for the size attribute.

Parameters:

size - The value for size

Returns:

this builder for use in a chained invocation

totalSize

public final PagedGroupResult.Builder totalSize(int totalSize)

Initializes the value for the totalSize attribute.

Parameters:

totalSize - The value for totalSize

Returns:

this builder for use in a chained invocation

build

public PagedGroupResult build()

Builds a new PagedGroupResult.

Returns:

An immutable instance of PagedGroupResult

Throws:

IllegalStateException - if any required attributes are missing