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 * XYCoordinateType.java
029 * ---------------------
030 * (C) Copyright 2007-2020 by Object Refinery Limited and Contributors.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.util;
038
039import java.io.ObjectStreamException;
040import java.io.Serializable;
041
042/**
043 * Represents several possible interpretations for an (x, y) coordinate.
044 *
045 * @since 1.0.11
046 */
047public final class XYCoordinateType implements Serializable {
048
049    /** The (x, y) coordinates represent a point in the data space. */
050    public static final XYCoordinateType DATA
051            = new XYCoordinateType("XYCoordinateType.DATA");
052
053    /**
054     * The (x, y) coordinates represent a relative position in the data space.
055     * In this case, the values should be in the range (0.0 to 1.0).
056     */
057    public static final XYCoordinateType RELATIVE
058            = new XYCoordinateType("XYCoordinateType.RELATIVE");
059
060    /**
061     * The (x, y) coordinates represent indices in a dataset.
062     * In this case, the values should be in the range (0.0 to 1.0).
063     */
064    public static final XYCoordinateType INDEX
065            = new XYCoordinateType("XYCoordinateType.INDEX");
066
067    /** The name. */
068    private String name;
069
070    /**
071     * Private constructor.
072     *
073     * @param name  the name.
074     */
075    private XYCoordinateType(String name) {
076        this.name = name;
077    }
078
079    /**
080     * Returns a string representing the object.
081     *
082     * @return The string.
083     */
084    @Override
085    public String toString() {
086        return this.name;
087    }
088
089    /**
090     * Returns {@code true} if this object is equal to the specified
091     * object, and {@code false} otherwise.
092     *
093     * @param obj  the other object.
094     *
095     * @return A boolean.
096     */
097    @Override
098    public boolean equals(Object obj) {
099        if (this == obj) {
100            return true;
101        }
102        if (!(obj instanceof XYCoordinateType)) {
103            return false;
104        }
105        XYCoordinateType order = (XYCoordinateType) obj;
106        if (!this.name.equals(order.toString())) {
107            return false;
108        }
109        return true;
110    }
111
112    /**
113     * Ensures that serialization returns the unique instances.
114     *
115     * @return The object.
116     *
117     * @throws ObjectStreamException if there is a problem.
118     */
119    private Object readResolve() throws ObjectStreamException {
120        if (this.equals(XYCoordinateType.DATA)) {
121            return XYCoordinateType.DATA;
122        }
123        else if (this.equals(XYCoordinateType.RELATIVE)) {
124            return XYCoordinateType.RELATIVE;
125        }
126        else if (this.equals(XYCoordinateType.INDEX)) {
127            return XYCoordinateType.INDEX;
128        }
129        return null;
130    }
131
132}