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 * TickType.java
029 * -------------
030 * (C) Copyright 2007-present, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.axis;
038
039import java.io.ObjectStreamException;
040import java.io.Serializable;
041
042/**
043 * Used to indicate the tick type (MAJOR or MINOR).
044 */
045public final class TickType implements Serializable {
046
047    /** Major tick. */
048    public static final TickType MAJOR = new TickType("MAJOR");
049
050    /** Minor tick. */
051    public static final TickType MINOR = new TickType("MINOR");
052
053    /** The name. */
054    private String name;
055
056    /**
057     * Private constructor.
058     *
059     * @param name  the name.
060     */
061    private TickType(String name) {
062        this.name = name;
063    }
064
065    /**
066     * Returns a string representing the object.
067     *
068     * @return The string.
069     */
070    @Override
071    public String toString() {
072        return this.name;
073    }
074
075    /**
076     * Returns {@code true} if this object is equal to the specified
077     * object, and {@code false} otherwise.
078     *
079     * @param obj  the other object.
080     *
081     * @return A boolean.
082     */
083    @Override
084    public boolean equals(Object obj) {
085        if (this == obj) {
086            return true;
087        }
088        if (!(obj instanceof TickType)) {
089            return false;
090        }
091
092        TickType that = (TickType) obj;
093        if (!this.name.equals(that.name)) {
094            return false;
095        }
096        return true;
097    }
098
099    /**
100     * Ensures that serialization returns the unique instances.
101     *
102     * @return The object.
103     *
104     * @throws ObjectStreamException if there is a problem.
105     */
106    private Object readResolve() throws ObjectStreamException {
107        Object result = null;
108        if (this.equals(TickType.MAJOR)) {
109            result = TickType.MAJOR;
110        }
111        else if (this.equals(TickType.MINOR)) {
112            result = TickType.MINOR;
113        }
114        return result;
115    }
116
117}