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