LightQuserVO

/*
  * #%L
  * Quadrige3 Core
  * %%
  * Copyright (C) 2017 Ifremer
  * %%
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program 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 General Public License for more details.
  *
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  * #L%
  */
//
/**
 * @author Generated on 07/22/2024 16:45:05+0200 Do not modify by hand!
 *
 * TEMPLATE:     ValueObject.vsl in andromda-java-cartridge.
 * MODEL CLASS:  Données::fr.ifremer.quadrige3.core::vo::administration::user::LightQuserVO
 * STEREOTYPE:   ValueObject
 */
package fr.ifremer.quadrige3.core.vo.administration.user;

import java.io.Serializable;
import java.util.Arrays;
import org.apache.commons.lang3.builder.CompareToBuilder;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.apache.commons.lang3.builder.ToStringBuilder;

/**
 * TODO: Model Documentation for class LightQuserVO
 */
public class LightQuserVO
    implements Serializable, Comparable<LightQuserVO>
{
    /** The serial version UID of this class. Needed for serialization. */
    private static final long serialVersionUID = -1585720450855704024L;

    // Class attributes
    /** TODO: Model Documentation for attribute id */
    protected int id;
    /**
     * boolean setter for primitive attribute, so we can tell if it's initialized
     */
    protected boolean setId = false;
    /** TODO: Model Documentation for attribute lastname */
    protected String lastname;
    /** TODO: Model Documentation for attribute firstname */
    protected String firstname;

    /** Default Constructor with no properties */
    public LightQuserVO()
    {
        // Documented empty block - avoid compiler warning - no super constructor
    }

    /**
     * Constructor with all properties
     * @param idIn int
     * @param lastnameIn String
     * @param firstnameIn String
     */
    public LightQuserVO(final int idIn, final String lastnameIn, final String firstnameIn)
    {
        this.id = idIn;
        this.setId = true;
        this.lastname = lastnameIn;
        this.firstname = firstnameIn;
    }

    /**
     * Copies constructor from other LightQuserVO
     *
     * @param otherBean Cannot be <code>null</code>
     * @throws NullPointerException if the argument is <code>null</code>
     */
    public LightQuserVO(final LightQuserVO otherBean)
    {
        this.id = otherBean.getId();
        this.setId = true;
        this.lastname = otherBean.getLastname();
        this.firstname = otherBean.getFirstname();
    }

    /**
     * Copies all properties from the argument value object into this value object.
     * @param otherBean Cannot be <code>null</code>
     */
    public void copy(final LightQuserVO otherBean)
    {
        if (null != otherBean)
        {
            this.setId(otherBean.getId());
            this.setId = true;
            this.setLastname(otherBean.getLastname());
            this.setFirstname(otherBean.getFirstname());
        }
    }

    /**
     * TODO: Model Documentation for attribute id
     * Get the id Attribute
     * @return id int
     */
    public int getId()
    {
        return this.id;
    }

    /**
     *
     * @param value int
     */
    public void setId(final int value)
    {
        this.id = value;
        this.setId = true;
    }

    /**
     * Return true if the primitive attribute id is set, through the setter or constructor
     * @return true if the attribute value has been set
     */
    public boolean isSetId()
    {
        return this.setId;
    }

    /**
     * TODO: Model Documentation for attribute lastname
     * Get the lastname Attribute
     * @return lastname String
     */
    public String getLastname()
    {
        return this.lastname;
    }

    /**
     *
     * @param value String
     */
    public void setLastname(final String value)
    {
        this.lastname = value;
    }

    /**
     * TODO: Model Documentation for attribute firstname
     * Get the firstname Attribute
     * @return firstname String
     */
    public String getFirstname()
    {
        return this.firstname;
    }

    /**
     *
     * @param value String
     */
    public void setFirstname(final String value)
    {
        this.firstname = value;
    }

    /**
     * @param object to compare this object against
     * @return boolean if equal
     * @see Object#equals(Object)
     */
    @Override
    public boolean equals(final Object object)
    {
        if (object==null || object.getClass() != this.getClass())
        {
             return false;
        }
        // Check if the same object instance
        if (object==this)
        {
            return true;
        }
        LightQuserVO rhs = (LightQuserVO) object;
        return new EqualsBuilder()
            .append(this.getId(), rhs.getId())
            .append(this.getLastname(), rhs.getLastname())
            .append(this.getFirstname(), rhs.getFirstname())
            .isEquals();
    }

    /**
     * @param object to compare this object against
     * @return int if equal
     * @see Comparable#compareTo(Object)
     */
    public int compareTo(final LightQuserVO object)
    {
        if (object==null)
        {
            return -1;
        }
        // Check if the same object instance
        if (object==this)
        {
            return 0;
        }
        return new CompareToBuilder()
            .append(this.getId(), object.getId())
            .append(this.getLastname(), object.getLastname())
            .append(this.getFirstname(), object.getFirstname())
            .toComparison();
    }

    /**
     * @return int hashCode value
     * @see Object#hashCode()
     */
    @Override
    public int hashCode()
    {
        return new HashCodeBuilder(1249046965, -82296885)
            .append(this.getId())
            .append(this.getLastname())
            .append(this.getFirstname())
            .toHashCode();
    }

    /**
     * @return String representation of object
     * @see Object#toString()
     */
    @Override
    public String toString()
    {
        return new ToStringBuilder(this)
            .append("id", this.getId())
            .append("lastname", this.getLastname())
            .append("firstname", this.getFirstname())
            .toString();
    }

    /**
     * This is a convenient helper method which is able to detect whether or not two values are equal. Two values
     * are equal when they are both {@code null}, are arrays of the same length with equal elements or are
     * equal objects (this includes {@link java.util.Collection} and {@link java.util.Map} instances).
     *
     * <p/>Note that for array, collection or map instances the comparison runs one level deep.
     *
     * @param first the first object to compare, may be {@code null}
     * @param second the second object to compare, may be {@code null}
     * @return this method will return {@code true} in case both objects are equal as explained above;
     *      in all other cases this method will return {@code false}
     */
    protected static boolean equal(final Object first, final Object second)
    {
        final boolean equal;

        if (first == null)
        {
            equal = (second == null);
        }
        else if (first.getClass().isArray() && (second != null) && second.getClass().isArray())
        {
            equal = Arrays.equals((Object[])first, (Object[])second);
        }
        else // note that the following also covers java.util.Collection and java.util.Map
        {
            equal = first.equals(second);
        }

        return equal;
    }

    // LightQuserVO value-object java merge-point
}