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