    001/* ===========================================================
    002 * Orson Charts : a 3D chart library for the Java(tm) platform
    003 * ===========================================================
    004 *
    005 * (C)opyright 2013-2016, by Object Refinery Limited.  All rights reserved.
    006 *
    007 * http://www.object-refinery.com/orsoncharts/index.html
    008 *
    009 * This program is free software: you can redistribute it and/or modify
    010 * it under the terms of the GNU General Public License as published by
    011 * the Free Software Foundation, either version 3 of the License, or
    012 * (at your option) any later version.
    013 *
    014 * This program is distributed in the hope that it will be useful,
    015 * but WITHOUT ANY WARRANTY; without even the implied warranty of
    016 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    017 * GNU General Public License for more details.
    018 *
    019 * You should have received a copy of the GNU General Public License
    020 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    021 *
    022 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
    023 * Other names may be trademarks of their respective owners.]
    024 *
    025 * If you do not wish to be bound by the terms of the GPL, an alternative
    026 * commercial license can be purchased.  For details, please see visit the
    027 * Orson Charts home page:
    028 *
    029 * http://www.object-refinery.com/orsoncharts/index.html
    030 *
    031 */
    032
    033package com.orsoncharts.renderer;
    034
    035import java.io.Serializable;
    036
    037import com.orsoncharts.Range;
    038import com.orsoncharts.util.ArgChecks;
    039
    040/**
    041 * An abstract class from which a {@link ColorScale} implementation can be
    042 * derived.
    043 * <br><br>
    044 * NOTE: This class is serializable, but the serialization format is subject
    045 * to change in future releases and should not be relied upon for persisting
    046 * instances of this class.
    047 *
    048 * @since 1.1
    049 */
    050@SuppressWarnings("serial")
    051public abstract class AbstractColorScale implements Serializable {
    052
    053    /** The data value range for the scale. */
    054    private Range range;
    055
    056    /**
    057     * Creates a new color scale for the specified data value range.
    058     *
    059     * @param range  the data value range ({@code null} not permitted).
    060     */
    061    protected AbstractColorScale(Range range) {
    062        ArgChecks.nullNotPermitted(range, "range");
    063        this.range = range;
    064    }
    065
    066    /**
    067     * Returns the range of data values over which the scale is defined.  This
    068     * is specified via the constructor and once set cannot be changed.
    069     *
    070     * @return The range (never {@code null}).
    071     */
    072    public Range getRange() {
    073        return this.range;
    074    }
    075
    076    /**
    077     * Tests this color scale for equality with an arbitrary object.
    078     *
    079     * @param obj  the object ({@code null} permitted).
    080     *
    081     * @return A boolean.
    082     */
    083    @Override
    084    public boolean equals(Object obj) {
    085        if (obj == this) {
    086            return true;
    087        }
    088        if (!(obj instanceof AbstractColorScale)) {
    089            return false;
    090        }
    091        AbstractColorScale that = (AbstractColorScale) obj;
    092        if (!this.range.equals(that.range)) {
    093            return false;
    094        }
    095        return true;
    096    }
    097
    098}