KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > codehaus > loom > components > extensions > pkgmgr > impl > OptionalPackageComparator


1 /* ====================================================================
2  * Loom Software License, version 1.1
3  *
4  * Copyright (c) 2003, Loom Group. All rights reserved.
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  *
17  * 3. Neither the name of the Loom Group nor the name "Loom" nor
18  * the names of its contributors may be used to endorse or promote
19  * products derived from this software without specific prior
20  * written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  *
35  * ====================================================================
36  *
37  * Loom includes code from the Apache Software Foundation
38  *
39  * ====================================================================
40  * The Apache Software License, Version 1.1
41  *
42  * Copyright (c) 1997-2003 The Apache Software Foundation. All rights
43  * reserved.
44  *
45  * Redistribution and use in source and binary forms, with or without
46  * modification, are permitted provided that the following conditions
47  * are met:
48  *
49  * 1. Redistributions of source code must retain the above copyright
50  * notice, this list of conditions and the following disclaimer.
51  *
52  * 2. Redistributions in binary form must reproduce the above copyright
53  * notice, this list of conditions and the following disclaimer in
54  * the documentation and/or other materials provided with the
55  * distribution.
56  *
57  * 3. The end-user documentation included with the redistribution,
58  * if any, must include the following acknowledgment:
59  * "This product includes software developed by the
60  * Apache Software Foundation (http://www.apache.org/)."
61  * Alternately, this acknowledgment may appear in the software
62  * itself, if and wherever such third-party acknowledgments
63  * normally appear.
64  *
65  * 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
66  * must not be used to endorse or promote products derived from this
67  * software without prior written permission. For written
68  * permission, please contact apache@apache.org.
69  *
70  * 5. Products derived from this software may not be called "Apache",
71  * nor may "Apache" appear in their name, without prior written
72  * permission of the Apache Software Foundation.
73  *
74  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
75  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
76  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
77  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
78  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
79  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
80  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
81  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
82  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
83  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
84  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
85  * SUCH DAMAGE.
86  */

87 package org.codehaus.loom.components.extensions.pkgmgr.impl;
88
89 import java.util.Comparator JavaDoc;
90
91 import org.codehaus.loom.components.extensions.pkgmgr.OptionalPackage;
92 import org.codehaus.loom.extension.DeweyDecimal;
93 import org.codehaus.loom.extension.Extension;
94
95 /**
96  * A simple class to compare two extensions and sort them on spec version and
97  * then on impl version. Unspecified versions rate lower than specified
98  * versions.
99  *
100  * @author Peter Donald
101  * @version $Revision: 1.3 $ $Date: 2004/08/17 23:14:32 $
102  */

103 class OptionalPackageComparator
104     implements Comparator JavaDoc
105 {
106     /** The name of extension the comparator is working with. */
107     private final String JavaDoc m_name;
108
109     public OptionalPackageComparator( final String JavaDoc name )
110     {
111         if( null == name )
112         {
113             throw new NullPointerException JavaDoc( "name" );
114         }
115
116         m_name = name;
117     }
118
119     public int compare( final Object JavaDoc o1,
120                         final Object JavaDoc o2 )
121     {
122         final OptionalPackage pkg1 = (OptionalPackage)o1;
123         final OptionalPackage pkg2 = (OptionalPackage)o2;
124         final Extension e1 = getMatchingExtension( pkg1 );
125         final Extension e2 = getMatchingExtension( pkg2 );
126         int result = compareSpecVersion( e1, e2 );
127         if( 0 != result )
128         {
129             return result;
130         }
131         else
132         {
133             return compareImplVersion( e1, e2 );
134         }
135     }
136
137     private Extension getMatchingExtension( final OptionalPackage pkg )
138     {
139         final Extension[] extensions = pkg.getAvailableExtensions();
140         for( int i = 0; i < extensions.length; i++ )
141         {
142             final Extension extension = extensions[ i ];
143             if( extension.getExtensionName().equals( m_name ) )
144             {
145                 return extension;
146             }
147         }
148
149         final String JavaDoc message = "Unable to locate extension " +
150             m_name + " in package " + pkg;
151         throw new IllegalStateException JavaDoc( message );
152     }
153
154     private int compareImplVersion( final Extension e1, final Extension e2 )
155     {
156         final String JavaDoc implVersion1 = e1.getImplementationVersion();
157         final String JavaDoc implVersion2 = e2.getImplementationVersion();
158         if( null == implVersion1 && null == implVersion2 )
159         {
160             return 0;
161         }
162         else if( null != implVersion1 && null == implVersion2 )
163         {
164             return -1;
165         }
166         else if( null == implVersion1 && null != implVersion2 )
167         {
168             return 1;
169         }
170         else
171         {
172             return -implVersion1.compareTo( implVersion2 );
173         }
174     }
175
176     private int compareSpecVersion( final Extension e1,
177                                     final Extension e2 )
178     {
179         final DeweyDecimal specVersion1 = e1.getSpecificationVersion();
180         final DeweyDecimal specVersion2 = e2.getSpecificationVersion();
181         if( null == specVersion1 && null == specVersion2 )
182         {
183             return 0;
184         }
185         else if( null != specVersion1 && null == specVersion2 )
186         {
187             return -1;
188         }
189         else if( null == specVersion1 && null != specVersion2 )
190         {
191             return 1;
192         }
193         else
194         {
195             if( specVersion1.isEqual( specVersion2 ) )
196             {
197                 return 0;
198             }
199             else if( specVersion1.isGreaterThan( specVersion2 ) )
200             {
201                 return -1;
202             }
203             else
204             {
205                 return 1;
206             }
207         }
208     }
209 }
210
Popular Tags