com.clxcommunications.xms.api

Class KeywordPair

java.lang.Object

com.clxcommunications.xms.api.KeywordPair

@Value.Immutable
public abstract class KeywordPair
extends Object

A pair containing the first and second word of a group auto update trigger. Either trigger word may be null.

Constructor Summary

Constructors

Constructor and Description
KeywordPair()

Method Summary

Modifier and Type	Method and Description
abstract String	firstWord() The first keyword.
static KeywordPair	of(String firstWord, String secondWord) Builder of keyword pairs.
abstract String	secondWord() The second keyword.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywordPair

public KeywordPair()

Method Detail

firstWord

@Nullable
public abstract String firstWord()

The first keyword.

Returns:

an SMS keyword or null if no keyword is set

secondWord

@Nullable
public abstract String secondWord()

The second keyword.

Returns:

an SMS keyword or null if no keyword is set

of

@Nonnull
public static KeywordPair of(@Nullable
                                      String firstWord,
                                      @Nullable
                                      String secondWord)

Builder of keyword pairs.

Parameters:

firstWord - the first keyword

secondWord - the second keyword

Returns:

a keyword pair consisting of the given keywords