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