001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2013, by Object Refinery Limited 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 * RendererState.java
029 * ------------------
030 * (C) Copyright 2003-2008, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 * Changes:
036 * --------
037 * 07-Oct-2003 : Version 1 (DG);
038 * 09-Jun-2005 : Added a convenience method to access the entity
039 *               collection (DG);
040 *
041 */
042
043package org.jfree.chart.renderer;
044
045import org.jfree.chart.ChartRenderingInfo;
046import org.jfree.chart.entity.EntityCollection;
047import org.jfree.chart.plot.PlotRenderingInfo;
048
049/**
050 * Represents the current state of a renderer.
051 */
052public class RendererState {
053
054    /** The plot rendering info. */
055    private PlotRenderingInfo info;
056
057    /**
058     * Creates a new state object.
059     *
060     * @param info  the plot rendering info.
061     */
062    public RendererState(PlotRenderingInfo info) {
063        this.info = info;
064    }
065
066    /**
067     * Returns the plot rendering info.
068     *
069     * @return The info.
070     */
071    public PlotRenderingInfo getInfo() {
072        return this.info;
073    }
074
075    /**
076     * A convenience method that returns a reference to the entity
077     * collection (may be <code>null</code>) being used to record
078     * chart entities.
079     *
080     * @return The entity collection (possibly <code>null</code>).
081     */
082    public EntityCollection getEntityCollection() {
083        EntityCollection result = null;
084        if (this.info != null) {
085            ChartRenderingInfo owner = this.info.getOwner();
086            if (owner != null) {
087                result = owner.getEntityCollection();
088            }
089        }
090        return result;
091    }
092
093}