com.clxcommunications.xms

Class InboundsFilter.Builder

java.lang.Object

com.clxcommunications.xms.InboundsFilter.Builder

Enclosing class:

InboundsFilter

public static class InboundsFilter.Builder
extends Object

A builder of inbound messages filter.

Method Summary

Modifier and Type	Method and Description
InboundsFilter.Builder	addAllRecipients(Iterable<String> elements) Adds elements to recipients set.
InboundsFilter.Builder	addRecipient(String... elements) Adds elements to recipients set.
InboundsFilter.Builder	addRecipient(String element) Adds one element to recipients set.
InboundsFilter	build() Builds a new InboundsFilter.
InboundsFilter.Builder	endDate(LocalDate endDate) Initializes the value for the endDate attribute.
InboundsFilter.Builder	pageSize(int pageSize) Initializes the value for the pageSize attribute.
InboundsFilter.Builder	recipients(Iterable<String> elements) Sets or replaces all elements for recipients set.
InboundsFilter.Builder	startDate(LocalDate startDate) Initializes the value for the startDate attribute.
InboundsFilter.Builder	using(InboundsFilter instance) Fill a builder with attribute values from the provided InboundsFilter instance.

Methods inherited from class java.lang.Object

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

Method Detail

using

public final InboundsFilter.Builder using(InboundsFilter instance)

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

startDate

public final InboundsFilter.Builder startDate(@Nullable
                                              LocalDate startDate)

Initializes the value for the startDate attribute.

Parameters:

startDate - The value for startDate (can be null)

Returns:

this builder for use in a chained invocation

endDate

public final InboundsFilter.Builder endDate(@Nullable
                                            LocalDate endDate)

Initializes the value for the endDate attribute.

Parameters:

endDate - The value for endDate (can be null)

Returns:

this builder for use in a chained invocation

addRecipient

public final InboundsFilter.Builder addRecipient(String element)

Adds one element to recipients set.

Parameters:

element - A recipients element

Returns:

this builder for use in a chained invocation

addRecipient

public final InboundsFilter.Builder addRecipient(String... elements)

Adds elements to recipients set.

Parameters:

elements - An array of recipients elements

Returns:

this builder for use in a chained invocation

recipients

public final InboundsFilter.Builder recipients(Iterable<String> elements)

Sets or replaces all elements for recipients set.

Parameters:

elements - An iterable of recipients elements

Returns:

this builder for use in a chained invocation

addAllRecipients

public final InboundsFilter.Builder addAllRecipients(Iterable<String> elements)

Adds elements to recipients set.

Parameters:

elements - An iterable of recipients elements

Returns:

this builder for use in a chained invocation

build

public InboundsFilter build()

Builds a new InboundsFilter.

Returns:

An immutable instance of InboundsFilter

Throws:

IllegalStateException - if any required attributes are missing