com.clxcommunications.xms

Class BatchFilter.Builder

java.lang.Object

com.clxcommunications.xms.BatchFilter.Builder

Enclosing class:

BatchFilter

public static class BatchFilter.Builder
extends Object

A builder of batch filters.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

using

public final BatchFilter.Builder using(BatchFilter instance)

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

addSender

public final BatchFilter.Builder addSender(String element)

Adds one element to senders set.

Parameters:

element - A senders element

Returns:

this builder for use in a chained invocation

addSender

public final BatchFilter.Builder addSender(String... elements)

Adds elements to senders set.

Parameters:

elements - An array of senders elements

Returns:

this builder for use in a chained invocation

senders

public final BatchFilter.Builder senders(Iterable<String> elements)

Sets or replaces all elements for senders set.

Parameters:

elements - An iterable of senders elements

Returns:

this builder for use in a chained invocation

addAllSenders

public final BatchFilter.Builder addAllSenders(Iterable<String> elements)

Adds elements to senders set.

Parameters:

elements - An iterable of senders elements

Returns:

this builder for use in a chained invocation

addTag

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

Builds a new BatchFilter.

Returns:

An immutable instance of BatchFilter

Throws:

IllegalStateException - if any required attributes are missing