com.clxcommunications.xms.api

Class AutoUpdate.Builder

java.lang.Object

com.clxcommunications.xms.api.AutoUpdate.Builder

Enclosing class:

AutoUpdate

@NotThreadSafe
public static class AutoUpdate.Builder
extends Object

A builder of auto update descriptions. Initialize the desired attributes and call the build method to instantiate the object.

Method Summary

Modifier and Type	Method and Description
AutoUpdate.Builder	add(KeywordPair add) Initializes the value for the add attribute.
AutoUpdate.Builder	add(String firstWord, String secondWord) The keyword trigger to use for adding a number to a group.
AutoUpdate	build() Builds a new AutoUpdate.
AutoUpdate.Builder	recipient(String recipient) Initializes the value for the recipient attribute.
AutoUpdate.Builder	remove(KeywordPair remove) Initializes the value for the remove attribute.
AutoUpdate.Builder	remove(String firstWord, String secondWord) The keyword trigger to use for removing a number to a group.
AutoUpdate.Builder	using(AutoUpdate instance) Fill a builder with attribute values from the provided AutoUpdate instance.

Methods inherited from class java.lang.Object

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

Method Detail

add

public AutoUpdate.Builder add(String firstWord,
                              String secondWord)

The keyword trigger to use for adding a number to a group.

Parameters:

firstWord - the first keyword, can be null

secondWord - the second keyword, can be null

Returns:

this builder for use in a chained invocation

remove

public AutoUpdate.Builder remove(String firstWord,
                                 String secondWord)

The keyword trigger to use for removing a number to a group.

Parameters:

firstWord - the first keyword, can be null

secondWord - the second keyword, can be null

Returns:

this builder for use in a chained invocation

using

public final AutoUpdate.Builder using(AutoUpdate instance)

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

recipient

public final AutoUpdate.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

add

public final AutoUpdate.Builder add(@Nullable
                                    KeywordPair add)

Initializes the value for the add attribute.

Parameters:

add - The value for add (can be null)

Returns:

this builder for use in a chained invocation

remove

public final AutoUpdate.Builder remove(@Nullable
                                       KeywordPair remove)

Initializes the value for the remove attribute.

Parameters:

remove - The value for remove (can be null)

Returns:

this builder for use in a chained invocation

build

public AutoUpdate build()

Builds a new AutoUpdate.

Returns:

An immutable instance of AutoUpdate

Throws:

IllegalStateException - if any required attributes are missing