    001/* ===================================================
    002 * JFreeSVG : an SVG library for the Java(tm) platform
    003 * ===================================================
    004 *
    005 * (C)opyright 2013-2015, by Object Refinery Limited.  All rights reserved.
    006 *
    007 * Project Info:  http://www.jfree.org/jfreesvg/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 * JFreeSVG home page:
    028 *
    029 * http://www.jfree.org/jfreesvg
    030 *
    031 */
    032
    033package org.jfree.graphics2d;
    034
    035import java.awt.LinearGradientPaint;
    036import java.util.Arrays;
    037
    038/**
    039 * A wrapper for a {@code LinearGradientPaint} that can be used as the key
    040 * for a {@code Map} (including a {@code HashMap}).  This class is
    041 * used internally by {@code SVGGraphics2D} to track and re-use gradient
    042 * definitions.  {@code LinearGradientPaint} itself does not implement the
    043 * {@code equals()} and {@code hashCode()} methods, so it doesn't make a good
    044 * key for a {@code Map}.
    045 *
    046 * @since 1.9
    047 */
    048public class LinearGradientPaintKey {
    049
    050    private final LinearGradientPaint paint;
    051
    052    /**
    053     * Creates a new instance.
    054     *
    055     * @param lgp  the linear gradient paint ({@code null} not permitted).
    056     */
    057    public LinearGradientPaintKey(LinearGradientPaint lgp) {
    058        Args.nullNotPermitted(lgp, "lgp");
    059        this.paint = lgp;
    060    }
    061
    062    /**
    063     * Returns the {@code LinearGradientPaint} that was supplied to the
    064     * constructor.
    065     *
    066     * @return The {@code LinearGradientPaint} (never {@code null}).
    067     */
    068    public LinearGradientPaint getPaint() {
    069        return this.paint;
    070    }
    071
    072    /**
    073     * Tests this instance for equality with an arbitrary object.
    074     *
    075     * @param obj  the object to test ({@code null} permitted).
    076     *
    077     * @return A boolean.
    078     */
    079    @Override
    080    public boolean equals(Object obj) {
    081        if (obj == this) {
    082            return true;
    083        }
    084        if (! (obj instanceof LinearGradientPaint)) {
    085            return false;
    086        }
    087        LinearGradientPaint that = (LinearGradientPaint) obj;
    088        if (!this.paint.getStartPoint().equals(that.getStartPoint())) {
    089            return false;
    090        }
    091        if (!this.paint.getEndPoint().equals(that.getEndPoint())) {
    092            return false;
    093        }
    094        if (!Arrays.equals(this.paint.getColors(), that.getColors())) {
    095            return false;
    096        }
    097        if (!Arrays.equals(this.paint.getFractions(), that.getFractions())) {
    098            return false;
    099        }
    100        return true;
    101    }
    102
    103    /**
    104     * Returns a hash code for this instance.
    105     *
    106     * @return A hash code.
    107     */
    108    @Override
    109    public int hashCode() {
    110        int hash = 5;
    111        hash = 47 * hash + this.paint.getStartPoint().hashCode();
    112        hash = 47 * hash + this.paint.getEndPoint().hashCode();
    113        hash = 47 * hash + Arrays.hashCode(this.paint.getColors());
    114        hash = 47 * hash + Arrays.hashCode(this.paint.getFractions());
    115        return hash;
    116    }
    117
    118}