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 * ChartChangeEventType.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.event;
038
039import java.io.ObjectStreamException;
040import java.io.Serializable;
041
042/**
043 * Defines tokens used to indicate an event type.
044 */
045public final class ChartChangeEventType implements Serializable {
046
047    /** For serialization. */
048    private static final long serialVersionUID = 5481917022435735602L;
049
050    /** GENERAL. */
051    public static final ChartChangeEventType GENERAL
052            = new ChartChangeEventType("ChartChangeEventType.GENERAL");
053
054    /** NEW_DATASET. */
055    public static final ChartChangeEventType NEW_DATASET
056            = new ChartChangeEventType("ChartChangeEventType.NEW_DATASET");
057
058    /** DATASET_UPDATED. */
059    public static final ChartChangeEventType DATASET_UPDATED
060            = new ChartChangeEventType("ChartChangeEventType.DATASET_UPDATED");
061
062    /** The name. */
063    private final String name;
064
065    /**
066     * Private constructor.
067     *
068     * @param name  the name.
069     */
070    private ChartChangeEventType(String name) {
071        this.name = name;
072    }
073
074    /**
075     * Returns a string representing the object.
076     *
077     * @return The string.
078     */
079    @Override
080    public String toString() {
081        return this.name;
082    }
083
084    /**
085     * Returns {@code true} if this object is equal to the specified
086     * object, and {@code false} otherwise.
087     *
088     * @param obj  the object ({@code null} permitted).
089     *
090     * @return A boolean.
091     */
092    @Override
093    public boolean equals(Object obj) {
094        if (this == obj) {
095            return true;
096        }
097        if (!(obj instanceof ChartChangeEventType)) {
098            return false;
099        }
100        ChartChangeEventType that = (ChartChangeEventType) obj;
101        if (!this.name.equals(that.toString())) {
102            return false;
103        }
104        return true;
105    }
106
107    /**
108     * Returns a hash code value for the object.
109     *
110     * @return The hashcode
111     */
112    @Override
113    public int hashCode() {
114        return this.name.hashCode();
115    }
116
117    /**
118     * Ensures that serialization returns the unique instances.
119     *
120     * @return The object.
121     *
122     * @throws ObjectStreamException if there is a problem.
123     */
124    private Object readResolve() throws ObjectStreamException {
125        if (this.equals(ChartChangeEventType.GENERAL)) {
126            return ChartChangeEventType.GENERAL;
127        }
128        else if (this.equals(ChartChangeEventType.NEW_DATASET)) {
129            return ChartChangeEventType.NEW_DATASET;
130        }
131        else if (this.equals(ChartChangeEventType.DATASET_UPDATED)) {
132            return ChartChangeEventType.DATASET_UPDATED;
133        }
134        return null;
135    }
136
137}