com.clxcommunications.xms.api

Class RecipientDeliveryReport.Builder

java.lang.Object

com.clxcommunications.xms.api.RecipientDeliveryReport.Builder

Enclosing class:

RecipientDeliveryReport

public static final class RecipientDeliveryReport.Builder
extends Object

A builder of recipient delivery reports.

Method Summary

Modifier and Type	Method and Description
RecipientDeliveryReport.Builder	at(OffsetDateTime at) Initializes the value for the at attribute.
RecipientDeliveryReport.Builder	batchId(BatchId batchId) Initializes the value for the batchId attribute.
RecipientDeliveryReport	build() Builds a new RecipientDeliveryReport.
RecipientDeliveryReport.Builder	code(int code) Initializes the value for the code attribute.
RecipientDeliveryReport.Builder	operator(String operator) Initializes the value for the operator attribute.
RecipientDeliveryReport.Builder	operatorStatusAt(OffsetDateTime operatorStatusAt) Initializes the value for the operatorStatusAt attribute.
RecipientDeliveryReport.Builder	recipient(String recipient) Initializes the value for the recipient attribute.
RecipientDeliveryReport.Builder	status(DeliveryStatus status) Initializes the value for the status attribute.
RecipientDeliveryReport.Builder	statusMessage(String statusMessage) Initializes the value for the statusMessage attribute.
RecipientDeliveryReport.Builder	using(RecipientDeliveryReport instance) Fill a builder with attribute values from the provided RecipientDeliveryReport instance.

Methods inherited from class java.lang.Object

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

Method Detail

using

public final RecipientDeliveryReport.Builder using(RecipientDeliveryReport instance)

Fill a builder with attribute values from the provided RecipientDeliveryReport instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

batchId

public final RecipientDeliveryReport.Builder batchId(BatchId batchId)

Initializes the value for the batchId attribute.

Parameters:

batchId - The value for batchId

Returns:

this builder for use in a chained invocation

recipient

public final RecipientDeliveryReport.Builder recipient(String recipient)

Initializes the value for the recipient attribute.

Parameters:

recipient - The value for recipient

Returns:

this builder for use in a chained invocation

code

public final RecipientDeliveryReport.Builder code(int code)

Initializes the value for the code attribute.

Parameters:

code - The value for code

Returns:

this builder for use in a chained invocation

status

public final RecipientDeliveryReport.Builder status(DeliveryStatus status)

Initializes the value for the status attribute.

Parameters:

status - The value for status

Returns:

this builder for use in a chained invocation

statusMessage

public final RecipientDeliveryReport.Builder statusMessage(@Nullable
                                                           String statusMessage)

Initializes the value for the statusMessage attribute.

Parameters:

statusMessage - The value for statusMessage (can be null)

Returns:

this builder for use in a chained invocation

operator

public final RecipientDeliveryReport.Builder operator(@Nullable
                                                      String operator)

Initializes the value for the operator attribute.

Parameters:

operator - The value for operator (can be null)

Returns:

this builder for use in a chained invocation

at

public final RecipientDeliveryReport.Builder at(OffsetDateTime at)

Initializes the value for the at attribute.

Parameters:

at - The value for at

Returns:

this builder for use in a chained invocation

operatorStatusAt

public final RecipientDeliveryReport.Builder operatorStatusAt(@Nullable
                                                              OffsetDateTime operatorStatusAt)

Initializes the value for the operatorStatusAt attribute.

Parameters:

operatorStatusAt - The value for operatorStatusAt (can be null)

Returns:

this builder for use in a chained invocation

build

public RecipientDeliveryReport build()

Builds a new RecipientDeliveryReport.

Returns:

An immutable instance of RecipientDeliveryReport

Throws:

IllegalStateException - if any required attributes are missing