View Javadoc

1   package org.codehaus.classworlds;
2   
3   /*
4    $Id: Entry.java,v 1.2 2004/07/18 00:40:00 dandiep Exp $
5   
6    Copyright 2002 (C) The Werken Company. All Rights Reserved.
7    
8    Redistribution and use of this software and associated documentation
9    ("Software"), with or without modification, are permitted provided
10   that the following conditions are met:
11  
12   1. Redistributions of source code must retain copyright
13      statements and notices.  Redistributions must also contain a
14      copy of this document.
15   
16   2. Redistributions in binary form must reproduce the
17      above copyright notice, this list of conditions and the
18      following disclaimer in the documentation and/or other
19      materials provided with the distribution.
20   
21   3. The name "classworlds" must not be used to endorse or promote
22      products derived from this Software without prior written
23      permission of The Werken Company.  For written permission,
24      please contact bob@werken.com.
25   
26   4. Products derived from this Software may not be called "classworlds"
27      nor may "classworlds" appear in their names without prior written
28      permission of The Werken Company. "classworlds" is a registered
29      trademark of The Werken Company.
30   
31   5. Due credit should be given to The Werken Company.
32      (http://classworlds.werken.com/).
33   
34   THIS SOFTWARE IS PROVIDED BY THE WERKEN COMPANY AND CONTRIBUTORS
35   ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
36   NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
37   FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
38   THE WERKEN COMPANY OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
39   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
40   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
41   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
42   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
43   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
44   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
45   OF THE POSSIBILITY OF SUCH DAMAGE.
46   
47   */
48  
49  /***
50   * Import description entry.
51   *
52   * @author <a href="mailto:bob@eng.werken.com">bob mcwhirter</a>
53   */
54  class Entry implements Comparable
55  {
56      private final ClassRealm realm;
57  
58      private final String pkgName;
59  
60      Entry( ClassRealm realm, String pkgName )
61      {
62          this.realm = realm;
63  
64          this.pkgName = pkgName;
65      }
66  
67      // ------------------------------------------------------------
68      //     Instance methods
69      // ------------------------------------------------------------
70  
71      /***
72       * Retrieve the realm.
73       *
74       * @return The realm.
75       */
76      ClassRealm getRealm()
77      {
78          return this.realm;
79      }
80  
81      /***
82       * Retrieve the page name.
83       *
84       * @return The package name.
85       */
86      String getPackageName()
87      {
88          return this.pkgName;
89      }
90  
91      /***
92       * Determine if the classname matches the package
93       * described by this entry.
94       *
95       * @param classname The class name to test.
96       * @return <code>true</code> if this entry matches the
97       *         classname, otherwise <code>false</code>.
98       */
99      boolean matches( String classname )
100     {
101         return classname.startsWith( getPackageName() );
102     }
103 
104     // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
105     //     java.lang.Comparable
106     // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
107 
108     /***
109      * Compare this entry to another for relative ordering.
110      * <p/>
111      * <p/>
112      * The natural ordering of Entry objects is reverse-alphabetical
113      * based upon package name.
114      * </p>
115      *
116      * @param thatObj The object to compare.
117      * @return -1 if this object sorts before that object, 0
118      *         if they are equal, or 1 if this object sorts
119      *         after that object.
120      */
121     public int compareTo( Object thatObj )
122     {
123         Entry that = (Entry) thatObj;
124 
125         // We are reverse sorting this list, so that
126         // we get longer matches first:
127         //
128         //     com.werken.foo.bar
129         //     com.werken.foo
130         //     com.werken
131 
132         return ( getPackageName().compareTo( that.getPackageName() ) ) * -1;
133     }
134 
135     // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
136     //     java.lang.Object
137     // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
138 
139     /***
140      * Test this entry for equality to another.
141      * <p/>
142      * <p/>
143      * Consistent with {@link #compareTo}, this method tests
144      * for equality purely on the package name.
145      * </p>
146      *
147      * @param thatObj The object to compare
148      * @return <code>true</code> if the two objects are
149      *         semantically equivalent, otherwise <code>false</code>.
150      */
151     public boolean equals( Object thatObj )
152     {
153         Entry that = (Entry) thatObj;
154 
155         return getPackageName().equals( that.getPackageName() );
156     }
157 
158     /***
159      * <p/>
160      * Consistent with {@link #equals}, this method creates a hashCode
161      * based on the packagename.
162      * </p>
163      */
164     public int hashCode()
165     {
166         return getPackageName().hashCode();
167     }
168 }