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 * AreaRendererEndType.java
029 * ------------------------
030 * (C) Copyright 2004-present, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.renderer;
038
039import java.io.ObjectStreamException;
040import java.io.Serializable;
041
042/**
043 * An enumeration of the 'end types' for an area renderer.
044 */
045public final class AreaRendererEndType implements Serializable {
046
047    /** For serialization. */
048    private static final long serialVersionUID = -1774146392916359839L;
049
050    /**
051     * The area tapers from the first or last value down to zero.
052     */
053    public static final AreaRendererEndType TAPER = new AreaRendererEndType(
054            "AreaRendererEndType.TAPER");
055
056    /**
057     * The area is truncated at the first or last value.
058     */
059    public static final AreaRendererEndType TRUNCATE = new AreaRendererEndType(
060            "AreaRendererEndType.TRUNCATE");
061
062    /**
063     * The area is levelled at the first or last value.
064     */
065    public static final AreaRendererEndType LEVEL = new AreaRendererEndType(
066            "AreaRendererEndType.LEVEL");
067
068    /** The name. */
069    private final String name;
070
071    /**
072     * Private constructor.
073     *
074     * @param name  the name.
075     */
076    private AreaRendererEndType(String name) {
077        this.name = name;
078    }
079
080    /**
081     * Returns a string representing the object.
082     *
083     * @return The string.
084     */
085    @Override
086    public String toString() {
087        return this.name;
088    }
089
090    /**
091     * Returns {@code true} if this object is equal to the specified
092     * object, and {@code false} otherwise.
093     *
094     * @param obj  the object ({@code null} permitted).
095     *
096     * @return A boolean.
097     */
098    @Override
099    public boolean equals(Object obj) {
100        if (this == obj) {
101            return true;
102        }
103        if (!(obj instanceof AreaRendererEndType)) {
104            return false;
105        }
106        AreaRendererEndType that = (AreaRendererEndType) obj;
107        if (!this.name.equals(that.toString())) {
108            return false;
109        }
110        return true;
111    }
112
113    /**
114     * Ensures that serialization returns the unique instances.
115     *
116     * @return The object.
117     *
118     * @throws ObjectStreamException if there is a problem.
119     */
120    private Object readResolve() throws ObjectStreamException {
121        Object result = null;
122        if (this.equals(AreaRendererEndType.LEVEL)) {
123            result = AreaRendererEndType.LEVEL;
124        }
125        else if (this.equals(AreaRendererEndType.TAPER)) {
126            result = AreaRendererEndType.TAPER;
127        }
128        else if (this.equals(AreaRendererEndType.TRUNCATE)) {
129            result = AreaRendererEndType.TRUNCATE;
130        }
131        return result;
132    }
133
134}