/lib/jCommon-1.0.16/javadoc/src-html/org/jfree/xml/factory/objects/ClassComparator.html
HTML | 191 lines | 131 code | 60 blank | 0 comment | 0 complexity | e2eb42df197931c3c90fff3a925e81ff MD5 | raw file
- <HTML>
- <BODY BGCOLOR="white">
- <PRE>
- <FONT color="green">001</FONT> /* ========================================================================<a name="line.1"></a>
- <FONT color="green">002</FONT> * JCommon : a free general purpose class library for the Java(tm) platform<a name="line.2"></a>
- <FONT color="green">003</FONT> * ========================================================================<a name="line.3"></a>
- <FONT color="green">004</FONT> *<a name="line.4"></a>
- <FONT color="green">005</FONT> * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.<a name="line.5"></a>
- <FONT color="green">006</FONT> * <a name="line.6"></a>
- <FONT color="green">007</FONT> * Project Info: http://www.jfree.org/jcommon/index.html<a name="line.7"></a>
- <FONT color="green">008</FONT> *<a name="line.8"></a>
- <FONT color="green">009</FONT> * This library is free software; you can redistribute it and/or modify it <a name="line.9"></a>
- <FONT color="green">010</FONT> * under the terms of the GNU Lesser General Public License as published by <a name="line.10"></a>
- <FONT color="green">011</FONT> * the Free Software Foundation; either version 2.1 of the License, or <a name="line.11"></a>
- <FONT color="green">012</FONT> * (at your option) any later version.<a name="line.12"></a>
- <FONT color="green">013</FONT> *<a name="line.13"></a>
- <FONT color="green">014</FONT> * This library is distributed in the hope that it will be useful, but <a name="line.14"></a>
- <FONT color="green">015</FONT> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY <a name="line.15"></a>
- <FONT color="green">016</FONT> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public <a name="line.16"></a>
- <FONT color="green">017</FONT> * License for more details.<a name="line.17"></a>
- <FONT color="green">018</FONT> *<a name="line.18"></a>
- <FONT color="green">019</FONT> * You should have received a copy of the GNU Lesser General Public<a name="line.19"></a>
- <FONT color="green">020</FONT> * License along with this library; if not, write to the Free Software<a name="line.20"></a>
- <FONT color="green">021</FONT> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, <a name="line.21"></a>
- <FONT color="green">022</FONT> * USA. <a name="line.22"></a>
- <FONT color="green">023</FONT> *<a name="line.23"></a>
- <FONT color="green">024</FONT> * [Java is a trademark or registered trademark of Sun Microsystems, Inc. <a name="line.24"></a>
- <FONT color="green">025</FONT> * in the United States and other countries.]<a name="line.25"></a>
- <FONT color="green">026</FONT> * <a name="line.26"></a>
- <FONT color="green">027</FONT> * --------------------<a name="line.27"></a>
- <FONT color="green">028</FONT> * ClassComparator.java<a name="line.28"></a>
- <FONT color="green">029</FONT> * --------------------<a name="line.29"></a>
- <FONT color="green">030</FONT> * (C)opyright 2003, 2004, by Thomas Morgner and Contributors.<a name="line.30"></a>
- <FONT color="green">031</FONT> *<a name="line.31"></a>
- <FONT color="green">032</FONT> * Original Author: Thomas Morgner (taquera@sherito.org);<a name="line.32"></a>
- <FONT color="green">033</FONT> * Contributor(s): David Gilbert (for Object Refinery Limited);<a name="line.33"></a>
- <FONT color="green">034</FONT> *<a name="line.34"></a>
- <FONT color="green">035</FONT> * $Id: ClassComparator.java,v 1.5 2005/11/08 14:22:04 mungady Exp $<a name="line.35"></a>
- <FONT color="green">036</FONT> *<a name="line.36"></a>
- <FONT color="green">037</FONT> * Changes<a name="line.37"></a>
- <FONT color="green">038</FONT> * -------<a name="line.38"></a>
- <FONT color="green">039</FONT> * 02-May-2003 : Initial version<a name="line.39"></a>
- <FONT color="green">040</FONT> */<a name="line.40"></a>
- <FONT color="green">041</FONT> package org.jfree.xml.factory.objects;<a name="line.41"></a>
- <FONT color="green">042</FONT> <a name="line.42"></a>
- <FONT color="green">043</FONT> import java.io.Serializable;<a name="line.43"></a>
- <FONT color="green">044</FONT> import java.util.Comparator;<a name="line.44"></a>
- <FONT color="green">045</FONT> <a name="line.45"></a>
- <FONT color="green">046</FONT> /**<a name="line.46"></a>
- <FONT color="green">047</FONT> * The class comparator can be used to compare and sort classes and their<a name="line.47"></a>
- <FONT color="green">048</FONT> * superclasses. The comparator is not able to compare classes which have<a name="line.48"></a>
- <FONT color="green">049</FONT> * no relation...<a name="line.49"></a>
- <FONT color="green">050</FONT> *<a name="line.50"></a>
- <FONT color="green">051</FONT> * @author Thomas Morgner<a name="line.51"></a>
- <FONT color="green">052</FONT> * @deprecated Moved to org.jfree.util<a name="line.52"></a>
- <FONT color="green">053</FONT> */<a name="line.53"></a>
- <FONT color="green">054</FONT> public class ClassComparator implements Comparator, Serializable {<a name="line.54"></a>
- <FONT color="green">055</FONT> <a name="line.55"></a>
- <FONT color="green">056</FONT> /**<a name="line.56"></a>
- <FONT color="green">057</FONT> * Defaultconstructor.<a name="line.57"></a>
- <FONT color="green">058</FONT> */<a name="line.58"></a>
- <FONT color="green">059</FONT> public ClassComparator() {<a name="line.59"></a>
- <FONT color="green">060</FONT> super();<a name="line.60"></a>
- <FONT color="green">061</FONT> }<a name="line.61"></a>
- <FONT color="green">062</FONT> <a name="line.62"></a>
- <FONT color="green">063</FONT> /**<a name="line.63"></a>
- <FONT color="green">064</FONT> * Compares its two arguments for order. Returns a negative integer,<a name="line.64"></a>
- <FONT color="green">065</FONT> * zero, or a positive integer as the first argument is less than, equal<a name="line.65"></a>
- <FONT color="green">066</FONT> * to, or greater than the second.<p><a name="line.66"></a>
- <FONT color="green">067</FONT> * <P><a name="line.67"></a>
- <FONT color="green">068</FONT> * Note: throws ClassCastException if the arguments' types prevent them from<a name="line.68"></a>
- <FONT color="green">069</FONT> * being compared by this Comparator.<a name="line.69"></a>
- <FONT color="green">070</FONT> * And IllegalArgumentException if the classes share no relation.<a name="line.70"></a>
- <FONT color="green">071</FONT> *<a name="line.71"></a>
- <FONT color="green">072</FONT> * The implementor must ensure that <tt>sgn(compare(x, y)) ==<a name="line.72"></a>
- <FONT color="green">073</FONT> * -sgn(compare(y, x))</tt> for all <tt>x</tt> and <tt>y</tt>. (This<a name="line.73"></a>
- <FONT color="green">074</FONT> * implies that <tt>compare(x, y)</tt> must throw an exception if and only<a name="line.74"></a>
- <FONT color="green">075</FONT> * if <tt>compare(y, x)</tt> throws an exception.)<p><a name="line.75"></a>
- <FONT color="green">076</FONT> *<a name="line.76"></a>
- <FONT color="green">077</FONT> * The implementor must also ensure that the relation is transitive:<a name="line.77"></a>
- <FONT color="green">078</FONT> * <tt>((compare(x, y)&gt;0) &amp;&amp; (compare(y, z)&gt;0))</tt> implies<a name="line.78"></a>
- <FONT color="green">079</FONT> * <tt>compare(x, z)&gt;0</tt>.<p><a name="line.79"></a>
- <FONT color="green">080</FONT> *<a name="line.80"></a>
- <FONT color="green">081</FONT> * Finally, the implementer must ensure that <tt>compare(x, y)==0</tt><a name="line.81"></a>
- <FONT color="green">082</FONT> * implies that <tt>sgn(compare(x, z))==sgn(compare(y, z))</tt> for all<a name="line.82"></a>
- <FONT color="green">083</FONT> * <tt>z</tt>.<p><a name="line.83"></a>
- <FONT color="green">084</FONT> *<a name="line.84"></a>
- <FONT color="green">085</FONT> * It is generally the case, but <i>not</i> strictly required that<a name="line.85"></a>
- <FONT color="green">086</FONT> * <tt>(compare(x, y)==0) == (x.equals(y))</tt>. Generally speaking,<a name="line.86"></a>
- <FONT color="green">087</FONT> * any comparator that violates this condition should clearly indicate<a name="line.87"></a>
- <FONT color="green">088</FONT> * this fact. The recommended language is "Note: this comparator<a name="line.88"></a>
- <FONT color="green">089</FONT> * imposes orderings that are inconsistent with equals."<a name="line.89"></a>
- <FONT color="green">090</FONT> *<a name="line.90"></a>
- <FONT color="green">091</FONT> * @param o1 the first object to be compared.<a name="line.91"></a>
- <FONT color="green">092</FONT> * @param o2 the second object to be compared.<a name="line.92"></a>
- <FONT color="green">093</FONT> * @return a negative integer, zero, or a positive integer as the<a name="line.93"></a>
- <FONT color="green">094</FONT> * first argument is less than, equal to, or greater than the<a name="line.94"></a>
- <FONT color="green">095</FONT> * second.<a name="line.95"></a>
- <FONT color="green">096</FONT> */<a name="line.96"></a>
- <FONT color="green">097</FONT> public int compare(final Object o1, final Object o2) {<a name="line.97"></a>
- <FONT color="green">098</FONT> final Class c1 = (Class) o1;<a name="line.98"></a>
- <FONT color="green">099</FONT> final Class c2 = (Class) o2;<a name="line.99"></a>
- <FONT color="green">100</FONT> if (c1.equals(o2)) {<a name="line.100"></a>
- <FONT color="green">101</FONT> return 0;<a name="line.101"></a>
- <FONT color="green">102</FONT> }<a name="line.102"></a>
- <FONT color="green">103</FONT> if (c1.isAssignableFrom(c2)) {<a name="line.103"></a>
- <FONT color="green">104</FONT> return -1;<a name="line.104"></a>
- <FONT color="green">105</FONT> }<a name="line.105"></a>
- <FONT color="green">106</FONT> else {<a name="line.106"></a>
- <FONT color="green">107</FONT> if (!c2.isAssignableFrom(c2)) {<a name="line.107"></a>
- <FONT color="green">108</FONT> throw new IllegalArgumentException("The classes share no relation");<a name="line.108"></a>
- <FONT color="green">109</FONT> }<a name="line.109"></a>
- <FONT color="green">110</FONT> return 1;<a name="line.110"></a>
- <FONT color="green">111</FONT> }<a name="line.111"></a>
- <FONT color="green">112</FONT> }<a name="line.112"></a>
- <FONT color="green">113</FONT> <a name="line.113"></a>
- <FONT color="green">114</FONT> /**<a name="line.114"></a>
- <FONT color="green">115</FONT> * Checks, whether the given classes are comparable. This method will<a name="line.115"></a>
- <FONT color="green">116</FONT> * return true, if one of the classes is assignable from the other class.<a name="line.116"></a>
- <FONT color="green">117</FONT> *<a name="line.117"></a>
- <FONT color="green">118</FONT> * @param c1 the first class to compare<a name="line.118"></a>
- <FONT color="green">119</FONT> * @param c2 the second class to compare<a name="line.119"></a>
- <FONT color="green">120</FONT> * @return true, if the classes share a direct relation, false otherwise.<a name="line.120"></a>
- <FONT color="green">121</FONT> */<a name="line.121"></a>
- <FONT color="green">122</FONT> public boolean isComparable(final Class c1, final Class c2) {<a name="line.122"></a>
- <FONT color="green">123</FONT> return (c1.isAssignableFrom(c2) || c2.isAssignableFrom(c1));<a name="line.123"></a>
- <FONT color="green">124</FONT> }<a name="line.124"></a>
- <FONT color="green">125</FONT> }<a name="line.125"></a>
- </PRE>
- </BODY>
- </HTML>