com.clxcommunications.xms.api

Class PagedBatchResult.Builder

java.lang.Object

com.clxcommunications.xms.api.PagedBatchResult.Builder

Enclosing class:

PagedBatchResult

public static class PagedBatchResult.Builder
extends Object

A builder of batch result pages.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

using

public final PagedBatchResult.Builder using(PagedBatchResult instance)

Fill a builder with attribute values from the provided PagedBatchResult 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 PagedBatchResult.Builder addContent(MtBatchSmsResult element)

Adds one element to content list.

Parameters:

element - A content element

Returns:

this builder for use in a chained invocation

addContent

public final PagedBatchResult.Builder addContent(MtBatchSmsResult... 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 PagedBatchResult.Builder content(Iterable<? extends MtBatchSmsResult> 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 PagedBatchResult.Builder addAllContent(Iterable<? extends MtBatchSmsResult> 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 PagedBatchResult.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 PagedBatchResult.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 PagedBatchResult.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 PagedBatchResult build()

Builds a new PagedBatchResult.

Returns:

An immutable instance of PagedBatchResult

Throws:

IllegalStateException - if any required attributes are missing