co.ecg.alpaca.toolkit.helper.report.email

Class ToAddress

java.lang.Object

co.ecg.alpaca.toolkit.helper.report.email.ToAddress

All Implemented Interfaces:

Comparable<ToAddress>

public class ToAddress
extends Object
implements Comparable<ToAddress>

An Email to address with the option to generate its address dynamically. Created on: Sep 22, 2015

Author:

Matthew Keathley - support@e-c-group.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ToAddress.AddressType

Constructor Summary

Constructors

Constructor and Description
ToAddress(int priority, boolean isWildcard, String address) Creates a new static ToAddress with the given values
ToAddress(ToAddress.AddressType addressType, int priority, boolean isWildcard) Creates a new non-static ToAddress with the given values

Method Summary

Modifier and Type	Method and Description
int	compareTo(ToAddress o)
boolean	equals(Object o) Checks equality based on the email address value
String	getAddress()
ToAddress.AddressType	getAddressType()
int	getPriority()
boolean	isValid()
boolean	isWildcard()
void	populate(User user) ToAddress types that require a User must be populated prior to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToAddress

public ToAddress(ToAddress.AddressType addressType,
                 int priority,
                 boolean isWildcard)

Creates a new non-static ToAddress with the given values

Parameters:

addressType - The AddressType

priority - The Priority

isWildcard - Whether the address is a wildcard priority

ToAddress

public ToAddress(int priority,
                 boolean isWildcard,
                 String address)

Creates a new static ToAddress with the given values

Parameters:

priority - The Priority

isWildcard - Whether the address is a wildcard priority

address - The static email address

Method Detail

compareTo

public int compareTo(ToAddress o)

Specified by:

compareTo in interface Comparable<ToAddress>

equals

public boolean equals(Object o)

Checks equality based on the email address value

Overrides:

equals in class Object

getAddress

public String getAddress()

getAddressType

public ToAddress.AddressType getAddressType()

getPriority

public int getPriority()

isValid

public boolean isValid()

isWildcard

public boolean isWildcard()

populate

public void populate(User user)

ToAddress types that require a User must be populated prior to use. This method populates the email address based on the AddressType.

Parameters:

user - The user to retrieve the ToAddress for.