MessageIdBuilder.java

/**
 * Copyright (c) 2011-2012 Optimax Software Ltd.
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *  * Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  * Neither the name of Optimax Software, ElasticInbox, nor the names
 *    of its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.elasticinbox.core.message.id;

import java.util.Date;
import java.util.UUID;

/**
 * This builder generates new message UUID based on the provided parameters and
 * specific {@link AbstractMessageIdPolicy} implementation.
 * 
 * @author Rustam Aliyev
 */
public final class MessageIdBuilder
{
	protected String messageIdHeader; // message-id header
	protected Date sentDate;
	
	private static AbstractMessageIdPolicy sentDatePolicy = new SentDateMessageIdPolicy();
	private static AbstractMessageIdPolicy currentTimePolicy = new CurrentTimeMessageIdPolicy();

	/**
	 * Set <code>date</code> header from email
	 * 
	 * @param date
	 * @return
	 */
	public MessageIdBuilder setSentDate(Date date) {
		this.sentDate = date;
		return this;
	}

	/**
	 * Set <code>message-id</code> header from email
	 * 
	 * @param messageId
	 * @return
	 */
	public MessageIdBuilder setMessageIdHeader(String messageId) {
		this.messageIdHeader = messageId;
		return this;
	}

	/**
	 * Build new message UUID
	 * 
	 * @return
	 */
	public UUID build()
	{
		UUID messageId = null;
		
		if (sentDate != null) {
			messageId = sentDatePolicy.getMessageId(this);
		} else {
			messageId = currentTimePolicy.getMessageId(this);
		}

		return messageId;
	}
}