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 * CategoryLabelWidthType.java
029 * ---------------------------
030 * (C) Copyright 2004-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;
041import org.jfree.chart.util.Args;
042
043/**
044 * Represents the width types for a category label.
045 */
046public final class CategoryLabelWidthType implements Serializable {
047
048    /** For serialization. */
049    private static final long serialVersionUID = -6976024792582949656L;
050
051    /** Percentage of category. */
052    public static final CategoryLabelWidthType CATEGORY 
053            = new CategoryLabelWidthType("CategoryLabelWidthType.CATEGORY");
054
055    /** Percentage of range. */
056    public static final CategoryLabelWidthType RANGE 
057            = new CategoryLabelWidthType("CategoryLabelWidthType.RANGE");
058
059    /** The name. */
060    private String name;
061
062    /**
063     * Private constructor.
064     *
065     * @param name  the name ({@code null} not permitted).
066     */
067    private CategoryLabelWidthType(String name) {
068        Args.nullNotPermitted(name, "name");
069        this.name = name;
070    }
071
072    /**
073     * Returns a string representing the object.
074     *
075     * @return The string (never {@code null}).
076     */
077    @Override
078    public String toString() {
079        return this.name;
080    }
081
082    /**
083     * Returns {@code true} if this object is equal to the specified
084     * object, and {@code false} otherwise.
085     *
086     * @param obj  the other object.
087     *
088     * @return A boolean.
089     */
090    @Override
091    public boolean equals(Object obj) {
092        if (this == obj) {
093            return true;
094        }
095        if (!(obj instanceof CategoryLabelWidthType)) {
096            return false;
097        }
098        CategoryLabelWidthType t = (CategoryLabelWidthType) obj;
099        if (!this.name.equals(t.toString())) {
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        if (this.equals(CategoryLabelWidthType.CATEGORY)) {
114            return CategoryLabelWidthType.CATEGORY;
115        }
116        else if (this.equals(CategoryLabelWidthType.RANGE)) {
117            return CategoryLabelWidthType.RANGE;
118        }
119        return null;
120    }
121
122}