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 * BlockResult.java
029 * ----------------
030 * (C) Copyright 2005-present, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.block;
038
039import org.jfree.chart.entity.EntityCollection;
040
041/**
042 * Used to return results from the draw() method in the {@link Block}
043 * class.
044 */
045public class BlockResult implements EntityBlockResult {
046
047    /** The entities from the block. */
048    private EntityCollection entities;
049
050    /**
051     * Creates a new result instance.
052     */
053    public BlockResult() {
054        this.entities = null;
055    }
056
057    /**
058     * Returns the collection of entities from the block.
059     *
060     * @return The entities.
061     */
062    @Override
063    public EntityCollection getEntityCollection() {
064        return this.entities;
065    }
066
067    /**
068     * Sets the entities for the block.
069     *
070     * @param entities  the entities.
071     */
072    public void setEntityCollection(EntityCollection entities) {
073        this.entities = entities;
074    }
075
076}