1 /* =========================================================== 2 * JFreeChart : a free chart library for the Java(tm) platform 3 * =========================================================== 4 * 5 * (C) Copyright 2000-2013, by Object Refinery Limited and Contributors. 6 * 7 * Project Info: http://www.jfree.org/jfreechart/index.html 8 * 9 * This library is free software; you can redistribute it and/or modify it 10 * under the terms of the GNU Lesser General Public License as published by 11 * the Free Software Foundation; either version 2.1 of the License, or 12 * (at your option) any later version. 13 * 14 * This library is distributed in the hope that it will be useful, but 15 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 16 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 17 * License for more details. 18 * 19 * You should have received a copy of the GNU Lesser General Public 20 * License along with this library; if not, write to the Free Software 21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 22 * USA. 23 * 24 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 25 * Other names may be trademarks of their respective owners.] 26 * 27 * ------------------------- 28 * LegendRenderingOrder.java 29 * ------------------------- 30 * (C) Copyright 2004-2013, by Object Refinery Limited and Contributors. 31 * 32 * Original Author: Angel; 33 * Contributor(s): David Gilbert (for Object Refinery Limited); 34 * 35 * Changes 36 * ------- 37 * 26-Mar-2004 : Version 1 (DG); 38 * 39 */ 40 41 package org.jfree.chart; 42 43 import java.io.ObjectStreamException; 44 import java.io.Serializable; 45 46 /** 47 * Represents the order for rendering legend items. 48 */ 49 public final class LegendRenderingOrder implements Serializable { 50 51 /** For serialization. */ 52 private static final long serialVersionUID = -3832486612685808616L; 53 54 /** In order. */ 55 public static final LegendRenderingOrder STANDARD 56 = new LegendRenderingOrder("LegendRenderingOrder.STANDARD"); 57 58 /** In reverse order. */ 59 public static final LegendRenderingOrder REVERSE 60 = new LegendRenderingOrder("LegendRenderingOrder.REVERSE"); 61 62 /** The name. */ 63 private String name; 64 65 /** 66 * Private constructor. 67 * 68 * @param name the name. 69 */ LegendRenderingOrder(String name)70 private LegendRenderingOrder(String name) { 71 this.name = name; 72 } 73 74 /** 75 * Returns a string representing the object. 76 * 77 * @return The string. 78 */ 79 @Override toString()80 public String toString() { 81 return this.name; 82 } 83 84 /** 85 * Returns <code>true</code> if this object is equal to the specified 86 * object, and <code>false</code> otherwise. 87 * 88 * @param obj the other object. 89 * 90 * @return A boolean. 91 */ 92 @Override equals(Object obj)93 public boolean equals(Object obj) { 94 if (this == obj) { 95 return true; 96 } 97 if (!(obj instanceof LegendRenderingOrder)) { 98 return false; 99 } 100 LegendRenderingOrder order = (LegendRenderingOrder) obj; 101 if (!this.name.equals(order.toString())) { 102 return false; 103 } 104 return true; 105 } 106 107 /** 108 * Ensures that serialization returns the unique instances. 109 * 110 * @return The object. 111 * 112 * @throws ObjectStreamException if there is a problem. 113 */ readResolve()114 private Object readResolve() throws ObjectStreamException { 115 if (this.equals(LegendRenderingOrder.STANDARD)) { 116 return LegendRenderingOrder.STANDARD; 117 } 118 else if (this.equals(LegendRenderingOrder.REVERSE)) { 119 return LegendRenderingOrder.REVERSE; 120 } 121 return null; 122 } 123 124 } 125