RecipientBuilder.java

/*******************************************************************************
 * Copyright (c) 2011 - 2012 Siamak Haschemi & Benjamin Haupt
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *******************************************************************************/

package de.bht.fpa.mail.s000000.common.mail.model.builder;

import de.bht.fpa.mail.s000000.common.mail.model.Recipient;
import de.bht.fpa.mail.s000000.common.mail.model.RecipientType;

//@formatter:off
/**
* This class implements the builder design pattern and provides a fluent API.
* You can create Recipients like this:
* 
* <pre>
* Recipient recipient = RecipientBuilder.newRecipientBuilder()
*   .id(4711L)
*   .personal("Chuck Norris")
*   .email("chuck@norris.de")
*   .type(RecipientType.TO)
* .build(); 
* </pre>
* 
* @author Siamak Haschemi
* 
*/
//@formatter:on
public class RecipientBuilder {
  private Long id;
  private String email;
  private String personal;
  private RecipientType recipientType;

  public Recipient build() {
    Recipient recipient = new Recipient();
    recipient.setId(id);
    recipient.setEmail(email);
    recipient.setPersonal(personal);
    recipient.setType(recipientType);
    return recipient;
  }

  public RecipientBuilder but() {
    // @formatter:off
    return newRecipientBuilder()
        .id(id)
        .email(email)
        .personal(personal)
        .type(recipientType);
    // @formatter:on
  }

  public static RecipientBuilder newRecipientBuilder() {
    return new RecipientBuilder();
  }

  public RecipientBuilder id(Long id) {
    this.id = id;
    return this;
  }

  public RecipientBuilder personal(String personal) {
    this.personal = personal;
    return this;
  }

  public RecipientBuilder email(String email) {
    this.email = email;
    return this;
  }

  public RecipientBuilder type(RecipientType recipientType) {
    this.recipientType = recipientType;
    return this;
  }

}