org.lenskit.specs.AbstractSpec Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lenskit-specs Show documentation

JavaBeans describing various LensKit objects, used for serializing between Gradle and the CLI.

There is a newer version: 3.0-T5

/*
 * LensKit, an open source recommender systems toolkit.
 * Copyright 2010-2014 LensKit Contributors.  See CONTRIBUTORS.md.
 * Work on LensKit has been funded by the National Science Foundation under
 * grants IIS 05-34939, 08-08692, 08-12148, and 10-17697.
 *
 * This program 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; either version 2.1 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 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.lenskit.specs;

import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.apache.commons.lang3.builder.ToStringBuilder;

/**
 * Base class for specification beans.  This class provides default implementations of {@link #equals(Object)} and
 * {@link #hashCode()} for specifications.
 */
public abstract class AbstractSpec {
    /**
     * Test this spec for equality with another spec.  This implementation uses {@link EqualsBuilder#reflectionEquals(Object, Object, boolean)},
     * with transient fields excluded.
     *
     * @param o The object with which this spec should be compared.
     * @return `true` if the specs are equal.
     */
    @Override
    public boolean equals(Object o) {
        return EqualsBuilder.reflectionEquals(this, o, false);
    }

    /**
     * Compute a hash code for this spec.  This implementation uses {@link HashCodeBuilder#reflectionHashCode(Object, boolean)},
     * with transient fields excluded.
     *
     * @return The hash code.
     */
    @Override
    public int hashCode() {
        return HashCodeBuilder.reflectionHashCode(this, false);
    }

    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this);
    }
}