com.cryptshare.api

Class TemplateReplacement

java.lang.Object

com.cryptshare.api.TemplateReplacement

public class TemplateReplacement
extends java.lang.Object

Represents a replacement for a email template request, as performed with Client.requestEmailTemplate(String, Map, Locale, EmailFormat). A replacement is identified by a key, and can either have a single or a list value.

Constructor Summary

Constructors

Constructor and Description
TemplateReplacement(java.lang.String key) Constructor.
TemplateReplacement(java.lang.String key, java.util.List<java.lang.String> listValue) Constructor for list-valued replacements.
TemplateReplacement(java.lang.String key, java.lang.String singleValue) Constructor for single-valued replacements.

Method Summary

Modifier and Type	Method and Description
void	addListValueEntry(java.lang.String listValueEntry) Adds a new entry to the list of values, which will be created if needed.
boolean	equals(java.lang.Object other) Checks equality based on getKey().
java.lang.String	getKey() Returns the key that identifies the replacement.
java.util.List<java.lang.String>	getListValue() Returns the list-valued replacement, if any.
java.lang.String	getSingleValue() Returns the single-valued replacement, if any.
int	hashCode()
void	setListValue(java.util.List<java.lang.String> value) Sets the replacement value as a list of Strings.
void	setSingleValue(java.lang.String value) Sets the replacement value as a single String.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateReplacement

public TemplateReplacement(java.lang.String key)

Constructor.

Parameters:

key - The key that identifies the replacement.

TemplateReplacement

public TemplateReplacement(java.lang.String key,
                           java.lang.String singleValue)

Constructor for single-valued replacements.

Parameters:

key - The key that identifies the replacement.

singleValue - The replacement value as a single String.

TemplateReplacement

public TemplateReplacement(java.lang.String key,
                           java.util.List<java.lang.String> listValue)

Constructor for list-valued replacements.

Parameters:

key - The key that identifies the replacement.

listValue - The replacement value as a list of Strings.

Method Detail

getKey

public java.lang.String getKey()

Returns the key that identifies the replacement.

Returns:

The key that identifies the replacement.

getSingleValue

public java.lang.String getSingleValue()

Returns the single-valued replacement, if any.

Returns:

The replacement value or null.

setSingleValue

public void setSingleValue(java.lang.String value)

Sets the replacement value as a single String. It nulls out the getListValue(), so you can't have both.

Parameters:

value - The value to set as the single value.

getListValue

public java.util.List<java.lang.String> getListValue()

Returns the list-valued replacement, if any.

Returns:

The replacement value or null.

setListValue

public void setListValue(java.util.List<java.lang.String> value)

Sets the replacement value as a list of Strings. It nulls out the getSingleValue(), so you can't have both.

Parameters:

value - The value to set as list of Strings.

addListValueEntry

public void addListValueEntry(java.lang.String listValueEntry)

Adds a new entry to the list of values, which will be created if needed. It nulls out the getSingleValue().

Parameters:

listValueEntry - The replacement value to add to the list.

equals

public boolean equals(java.lang.Object other)

Checks equality based on getKey().

Overrides:

equals in class java.lang.Object

Parameters:

other - The other instance. If it's not a TemplateReplacement, the result is always false.

Returns:

true, if the getKey() of this and the other TemplateReplacement are equals, false otherwise.

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object