org.jfree.chart.plot.SeriesRenderingOrder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfreechart Show documentation
Show all versions of jfreechart Show documentation
JFreeChart is a class library, written in Java, for generating charts.
Utilising the Java2D API, it supports a wide range of chart types including
bar charts, pie charts, line charts, XY-plots, time series plots, Sankey charts
and more.
/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-present, by David Gilbert and Contributors.
*
* Project Info: http://www.jfree.org/jfreechart/index.html
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* --------------------------
* SeriesRenderingOrder.java
* --------------------------
* (C) Copyright 2005-present, by David Gilbert.
*
* Original Author: Eric Thomas (www.isti.com);
* Contributor(s): David Gilbert;
*
*/
package org.jfree.chart.plot;
import java.io.ObjectStreamException;
import java.io.Serializable;
/**
* Defines the tokens that indicate the rendering order for series in a
* {@link org.jfree.chart.plot.XYPlot}.
*/
public final class SeriesRenderingOrder implements Serializable {
/** For serialization. */
private static final long serialVersionUID = 209336477448807735L;
/**
* Render series in the order 0, 1, 2, ..., N-1, where N is the number
* of series.
*/
public static final SeriesRenderingOrder FORWARD
= new SeriesRenderingOrder("SeriesRenderingOrder.FORWARD");
/**
* Render series in the order N-1, N-2, ..., 2, 1, 0, where N is the
* number of series.
*/
public static final SeriesRenderingOrder REVERSE
= new SeriesRenderingOrder("SeriesRenderingOrder.REVERSE");
/** The name. */
private String name;
/**
* Private constructor.
*
* @param name the name.
*/
private SeriesRenderingOrder(String name) {
this.name = name;
}
/**
* Returns a string representing the object.
*
* @return The string (never {@code null}).
*/
@Override
public String toString() {
return this.name;
}
/**
* Returns {@code true} if this object is equal to the specified
* object, and {@code false} otherwise.
*
* @param obj the object ({@code null} permitted).
*
* @return A boolean.
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof SeriesRenderingOrder)) {
return false;
}
SeriesRenderingOrder order = (SeriesRenderingOrder) obj;
if (!this.name.equals(order.toString())) {
return false;
}
return true;
}
/**
* Returns a hash code for this instance.
*
* @return A hash code.
*/
@Override
public int hashCode() {
return this.name.hashCode();
}
/**
* Ensures that serialization returns the unique instances.
*
* @return The object.
*
* @throws ObjectStreamException if there is a problem.
*/
private Object readResolve() throws ObjectStreamException {
if (this.equals(SeriesRenderingOrder.FORWARD)) {
return SeriesRenderingOrder.FORWARD;
}
else if (this.equals(SeriesRenderingOrder.REVERSE)) {
return SeriesRenderingOrder.REVERSE;
}
return null;
}
}