org.bonitasoft.engine.identity.ContactDataCreator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bonita-common Show documentation
Bonita Common is the useful layer common to bonita-client and bonita-server
There is a newer version: 10.2.0
/**
 * Copyright (C) 2019 Bonitasoft S.A.
 * Bonitasoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation
 * version 2.1 of the License.
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301, USA.
 **/
package org.bonitasoft.engine.identity;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;

/**
 * Represents a helper for creating {@link ContactData}. Chaining is possible with this creator to ease the ContactData
 * creation.
 * 

 * For instance, new ContactDataCreator().setEmail("[email protected]").setPhoneNumber("012456789");
 *
 * @author Matthieu Chaffotte
 * @author Celine Souchet
 * @since 6.0.0
 */
public class ContactDataCreator implements Serializable {

    private static final long serialVersionUID = -1414989152963184543L;

    /**
     * Represents the available {@link ContactData} fields
     */
    public enum ContactDataField {
        EMAIL, PHONE, MOBILE, FAX, BUILDING, ROOM, ADDRESS, ZIP_CODE, CITY, STATE, COUNTRY, WEBSITE;
    }

    private final Map fields;

    /**
     * Create a new creator instance
     */
    public ContactDataCreator() {
        fields = new HashMap(5);
    }

    /**
     * @param email
     *        The contact email address to create
     * @return The current {@link ContactDataCreator}
     */
    public ContactDataCreator setEmail(final String email) {
        fields.put(ContactDataField.EMAIL, email);
        return this;
    }

    /**
     * @param phoneNumber
     *        The contact phone number to create
     * @return The current {@link ContactDataCreator}
     */
    public ContactDataCreator setPhoneNumber(final String phoneNumber) {
        fields.put(ContactDataField.PHONE, phoneNumber);
        return this;
    }

    /**
     * @param mobileNumber
     *        The contact mobile number to create
     * @return The current {@link ContactDataCreator}
     */
    public ContactDataCreator setMobileNumber(final String mobileNumber) {
        fields.put(ContactDataField.MOBILE, mobileNumber);
        return this;
    }

    /**
     * @param faxNumber
     *        The contact fax number to create
     * @return The current {@link ContactDataCreator}
     */
    public ContactDataCreator setFaxNumber(final String faxNumber) {
        fields.put(ContactDataField.FAX, faxNumber);
        return this;
    }

    /**
     * @param building
     *        The contact building to create
     * @return The current {@link ContactDataCreator}
     */
    public ContactDataCreator setBuilding(final String building) {
        fields.put(ContactDataField.BUILDING, building);
        return this;
    }

    /**
     * @param room
     *        The contact room to create
     * @return The current {@link ContactDataCreator}
     */
    public ContactDataCreator setRoom(final String room) {
        fields.put(ContactDataField.ROOM, room);
        return this;
    }

    /**
     * @param address
     *        The contact address to create
     * @return The current {@link ContactDataCreator}
     */
    public ContactDataCreator setAddress(final String address) {
        fields.put(ContactDataField.ADDRESS, address);
        return this;
    }

    /**
     * @param zipCode
     *        The contact ZIP code to create
     * @return The current {@link ContactDataCreator}
     */
    public ContactDataCreator setZipCode(final String zipCode) {
        fields.put(ContactDataField.ZIP_CODE, zipCode);
        return this;
    }

    /**
     * @param city
     *        The contact city to create
     * @return The current {@link ContactDataCreator}
     */
    public ContactDataCreator setCity(final String city) {
        fields.put(ContactDataField.CITY, city);
        return this;
    }

    /**
     * @param state
     *        The contact state to create
     * @return The current {@link ContactDataCreator}
     */
    public ContactDataCreator setState(final String state) {
        fields.put(ContactDataField.STATE, state);
        return this;
    }

    /**
     * @param country
     *        The contact country to create
     * @return The current {@link ContactDataCreator}
     */
    public ContactDataCreator setCountry(final String country) {
        fields.put(ContactDataField.COUNTRY, country);
        return this;
    }

    /**
     * @param website
     *        The contact web site address to create
     * @return The current {@link ContactDataCreator}
     */
    public ContactDataCreator setWebsite(final String website) {
        fields.put(ContactDataField.WEBSITE, website);
        return this;
    }

    /**
     * @return The current contact data information to create
     */
    public Map getFields() {
        return fields;
    }

}