KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > ungoverned > moduleloader > search > SelectionPolicy


1 /*
2  * ModuleLoader - A generic, policy-driven class loader.
3  * Copyright (c) 2004, Richard S. Hall
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  * * 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  * * Neither the name of the ungoverned.org nor the names of its
17  * contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * Contact: Richard S. Hall (heavy@ungoverned.org)
33  * Contributor(s):
34  *
35 **/
36 package org.ungoverned.moduleloader.search;
37
38 import org.ungoverned.moduleloader.Module;
39
40 /**
41  * <p>
42  * This interface represents the policy for selecting a specific export
43  * target from multiple <i>compatible</i> candidate export targets when
44  * the <tt>ImportSearchPolicy</tt> is trying to resolve an import target
45  * for a given module. A concrete implementation of this interface is
46  * required to create an instance of <tt>ImportSearchPolicy</tt>.
47  * </p>
48  * @see org.ungoverned.moduleloader.search.ImportSearchPolicy
49 **/
50 public interface SelectionPolicy
51 {
52     /**
53      * Selects a single module to resolve the specified import
54      * from the array of compatible candidate modules.
55      * @param module the module that is importing the target.
56      * @param identifier the identifier of the import target.
57      * @param version the version number of the import target.
58      * @param candidates array of compatible candidate modules from which to choose.
59      * @param compatPolicy the compatibility policy that is being used.
60      * @return the selected module or <tt>null</tt> if no module
61      * can be selected.
62     **/
63     public Module select(
64         Module module, Object JavaDoc identifier, Object JavaDoc version, Module[] candidates,
65         CompatibilityPolicy compatPolicy);
66 }
Popular Tags