001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2020, 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 * AxisCollection.java
029 * -------------------
030 * (C) Copyright 2003-2016, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 * Changes
036 * -------
037 * 03-Nov-2003 : Added standard header (DG);
038 * 02-Jul-2013 : Use ParamChecks (DG);
039 *
040 */
041
042package org.jfree.chart.axis;
043
044import java.util.List;
045import org.jfree.chart.ui.RectangleEdge;
046import org.jfree.chart.util.Args;
047
048/**
049 * A collection of axes that have been assigned to the TOP, BOTTOM, LEFT or
050 * RIGHT of a chart.  This class is used internally by JFreeChart, you won't
051 * normally need to use it yourself.
052 */
053public class AxisCollection {
054
055    /** The axes that need to be drawn at the top of the plot area. */
056    private List axesAtTop;
057
058    /** The axes that need to be drawn at the bottom of the plot area. */
059    private List axesAtBottom;
060
061    /** The axes that need to be drawn at the left of the plot area. */
062    private List axesAtLeft;
063
064    /** The axes that need to be drawn at the right of the plot area. */
065    private List axesAtRight;
066
067    /**
068     * Creates a new empty collection.
069     */
070    public AxisCollection() {
071        this.axesAtTop = new java.util.ArrayList();
072        this.axesAtBottom = new java.util.ArrayList();
073        this.axesAtLeft = new java.util.ArrayList();
074        this.axesAtRight = new java.util.ArrayList();
075    }
076
077    /**
078     * Returns a list of the axes (if any) that need to be drawn at the top of
079     * the plot area.
080     *
081     * @return A list of axes.
082     */
083    public List getAxesAtTop() {
084        return this.axesAtTop;
085    }
086
087   /**
088    * Returns a list of the axes (if any) that need to be drawn at the bottom
089    * of the plot area.
090    *
091    * @return A list of axes.
092    */
093   public List getAxesAtBottom() {
094        return this.axesAtBottom;
095    }
096
097    /**
098     * Returns a list of the axes (if any) that need to be drawn at the left
099     * of the plot area.
100     *
101     * @return A list of axes.
102     */
103    public List getAxesAtLeft() {
104        return this.axesAtLeft;
105    }
106
107    /**
108    * Returns a list of the axes (if any) that need to be drawn at the right
109    * of the plot area.
110    *
111    * @return A list of axes.
112    */
113    public List getAxesAtRight() {
114        return this.axesAtRight;
115    }
116
117    /**
118     * Adds an axis to the collection.
119     *
120     * @param axis  the axis ({@code null} not permitted).
121     * @param edge  the edge of the plot that the axis should be drawn on
122     *              ({@code null} not permitted).
123     */
124    public void add(Axis axis, RectangleEdge edge) {
125        Args.nullNotPermitted(axis, "axis");
126        Args.nullNotPermitted(edge, "edge");
127        if (edge == RectangleEdge.TOP) {
128            this.axesAtTop.add(axis);
129        }
130        else if (edge == RectangleEdge.BOTTOM) {
131            this.axesAtBottom.add(axis);
132        }
133        else if (edge == RectangleEdge.LEFT) {
134            this.axesAtLeft.add(axis);
135        }
136        else if (edge == RectangleEdge.RIGHT) {
137            this.axesAtRight.add(axis);
138        }
139    }
140
141}