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 * DrawingSupplier.java
029 * --------------------
030 * (C) Copyright 2003-present, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.plot;
038
039import java.awt.Paint;
040import java.awt.Shape;
041import java.awt.Stroke;
042
043/**
044 * A supplier of {@code Paint}, {@code Stroke} and {@code Shape}
045 * objects for use by plots and renderers.  By providing a central place for
046 * obtaining these items, we can ensure that duplication is avoided.
047 * <p>
048 * To support the cloning of charts, classes that implement this interface
049 * should also implement {@code PublicCloneable}.
050 */
051public interface DrawingSupplier {
052
053    /**
054     * Returns the next paint in a sequence maintained by the supplier.
055     *
056     * @return The paint.
057     */
058    Paint getNextPaint();
059
060    /**
061     * Returns the next outline paint in a sequence maintained by the supplier.
062     *
063     * @return The paint.
064     */
065    Paint getNextOutlinePaint();
066
067    /**
068     * Returns the next fill paint in a sequence maintained by the supplier.
069     *
070     * @return The paint.
071     */
072    Paint getNextFillPaint();
073
074    /**
075     * Returns the next {@code Stroke} object in a sequence maintained by
076     * the supplier.
077     *
078     * @return The stroke.
079     */
080    Stroke getNextStroke();
081
082    /**
083     * Returns the next {@code Stroke} object in a sequence maintained by
084     * the supplier.
085     *
086     * @return The stroke.
087     */
088    Stroke getNextOutlineStroke();
089
090    /**
091     * Returns the next {@code Shape} object in a sequence maintained by
092     * the supplier.
093     *
094     * @return The shape.
095     */
096    Shape getNextShape();
097
098}