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