com.clxcommunications.xms.api

Class ParameterValues.Builder

java.lang.Object

com.clxcommunications.xms.api.ParameterValues.Builder

Enclosing class:

ParameterValues

public static class ParameterValues.Builder
extends Object

A builder of parameter substitution values.

Method Summary

Modifier and Type	Method and Description
ParameterValues	build() Builds a new ParameterValues.
ParameterValues.Builder	defaultValue(String defaultValue) Initializes the value for the defaultValue attribute.
ParameterValues.Builder	putAllSubstitutions(Map<String,? extends String> substitutions) Put all mappings from the specified map as entries to substitutions map.
ParameterValues.Builder	putSubstitution(Map.Entry<String,? extends String> entry) Put one entry to the substitutions map.
ParameterValues.Builder	putSubstitution(String key, String value) Put one entry to the substitutions map.
ParameterValues.Builder	substitutions(Map<String,? extends String> substitutions) Sets or replaces all mappings from the specified map as entries for the substitutions map.
ParameterValues.Builder	using(ParameterValues instance) Fill a builder with attribute values from the provided ParameterValues instance.

Methods inherited from class java.lang.Object

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

Method Detail

using

public final ParameterValues.Builder using(ParameterValues instance)

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

putSubstitution

public final ParameterValues.Builder putSubstitution(String key,
                                                     String value)

Put one entry to the substitutions map.

Parameters:

key - The key in the substitutions map

value - The associated value in the substitutions map

Returns:

this builder for use in a chained invocation

putSubstitution

public final ParameterValues.Builder putSubstitution(Map.Entry<String,? extends String> entry)

Put one entry to the substitutions map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

substitutions

public final ParameterValues.Builder substitutions(Map<String,? extends String> substitutions)

Sets or replaces all mappings from the specified map as entries for the substitutions map. Nulls are not permitted

Parameters:

substitutions - The entries that will be added to the substitutions map

Returns:

this builder for use in a chained invocation

putAllSubstitutions

public final ParameterValues.Builder putAllSubstitutions(Map<String,? extends String> substitutions)

Put all mappings from the specified map as entries to substitutions map. Nulls are not permitted

Parameters:

substitutions - The entries that will be added to the substitutions map

Returns:

this builder for use in a chained invocation

defaultValue

public final ParameterValues.Builder defaultValue(@Nullable
                                                  String defaultValue)

Initializes the value for the defaultValue attribute.

Parameters:

defaultValue - The value for defaultValue (can be null)

Returns:

this builder for use in a chained invocation

build

public ParameterValues build()

Builds a new ParameterValues.

Returns:

An immutable instance of ParameterValues

Throws:

IllegalStateException - if any required attributes are missing