com.clxcommunications.xms.api

Class ParameterValues

java.lang.Object

com.clxcommunications.xms.api.ParameterValues

@Value.Immutable
public abstract class ParameterValues
extends Object

A description of possible substitution values for a template parameter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParameterValues.Builder A builder of parameter substitution values.

Constructor Summary

Constructors

Constructor and Description
ParameterValues()

Method Summary

Modifier and Type	Method and Description
static ParameterValues.Builder	builder() Creates a builder of ParameterValues instances.
abstract String	defaultValue() The default substitution.
abstract Map<String,String>	substitutions() Describes per-recipient substitutions for a text message template.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterValues

public ParameterValues()

Method Detail

builder

@Nonnull
public static final ParameterValues.Builder builder()

Creates a builder of ParameterValues instances.

Returns:

a builder

substitutions

public abstract Map<String,String> substitutions()

Describes per-recipient substitutions for a text message template.

Returns:

map from MSISDNs to textual substitutions

defaultValue

@Nullable
public abstract String defaultValue()

The default substitution. Used when no matching substitution is found in substitutions().

Returns:

the default value for the parameter; null if no default is set