org.bonitasoft.engine.identity.CustomUserInfoDefinitionCreator 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.Objects;

/**
 * represents a helper for creating a {@link CustomUserInfoDefinition}.
 *
 * @author Vincent Elcrin
 * @see CustomUserInfoDefinition
 * @since 6.3.1
 */
public class CustomUserInfoDefinitionCreator implements Serializable {

    private static final long serialVersionUID = 6929368716340973445L;

    private String name;

    private String description;

    /**
     * creates a new {@link CustomUserInfoDefinitionCreator} with the specified name
     *
     * @param name the name to set
     */
    public CustomUserInfoDefinitionCreator(final String name) {
        this.name = name;
    }

    /**
     * creates a new {@link CustomUserInfoDefinitionCreator} with the specified name and description
     *
     * @param name the name to set
     * @param description the description to set
     */
    public CustomUserInfoDefinitionCreator(final String name, final String description) {
        this(name);
        this.description = description;
    }

    /**
     * @return the {@link CustomUserInfoDefinitionCreator}'s name to create
     */
    public String getName() {
        return name;
    }

    /**
     * @return the {@link CustomUserInfoDefinitionCreator}'s description to create
     */
    public String getDescription() {
        return description;
    }

    /**
     * @param name the {@link CustomUserInfoDefinitionCreator}'s name to create
     */
    public void setName(final String name) {
        this.name = name;
    }

    /**
     * @param description the {@link CustomUserInfoDefinitionCreator}'s name to create
     */
    public void setDescription(final String description) {
        this.description = description;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o)
            return true;
        if (o == null || getClass() != o.getClass())
            return false;
        CustomUserInfoDefinitionCreator that = (CustomUserInfoDefinitionCreator) o;
        return Objects.equals(name, that.name) &&
                Objects.equals(description, that.description);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, description);
    }

    @Override
    public String toString() {
        return "CustomUserInfoDefinitionCreator{" +
                "name='" + name + '\'' +
                ", description='" + description + '\'' +
                '}';
    }
}