001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
022 * USA.
023 *
024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * ---------------
028 * PaintScale.java
029 * ---------------
030 * (C) Copyright 2006-present, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.renderer;
038
039import java.awt.Paint;
040
041import org.jfree.chart.renderer.xy.XYBlockRenderer;
042
043/**
044 * A source for {@code Paint} instances, used by the
045 * {@link XYBlockRenderer}.
046 * <br><br>
047 * NOTE: Classes that implement this interface should also implement
048 * {@code PublicCloneable} and {@code Serializable}, so
049 * that any renderer (or other object instance) that references an instance of
050 * this interface can still be cloned or serialized.
051 */
052public interface PaintScale {
053
054    /**
055     * Returns the lower bound for the scale.
056     *
057     * @return The lower bound.
058     *
059     * @see #getUpperBound()
060     */
061    double getLowerBound();
062
063    /**
064     * Returns the upper bound for the scale.
065     *
066     * @return The upper bound.
067     *
068     * @see #getLowerBound()
069     */
070    double getUpperBound();
071
072    /**
073     * Returns a {@code Paint} instance for the specified value.
074     *
075     * @param value  the value.
076     *
077     * @return A {@code Paint} instance (never {@code null}).
078     */
079    Paint getPaint(double value);
080
081}