KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > deployment > annotation > Scanner


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24 package com.sun.enterprise.deployment.annotation;
25
26 import java.util.Set JavaDoc;
27
28 /**
29  * This interface is responsible for scanning the binary location
30  * provided and provide each binary file through a pull interfaces
31  *
32  * @author Jerome Dochez
33  */
34 public interface Scanner {
35     
36     /**
37      * Returns a ClassLoader capable of loading classes from the
38      * underlying medium
39      * @return a class loader capable of loading the classes
40      */
41     public ClassLoader JavaDoc getClassLoader();
42     
43     /**
44      * Return a complete set of classes available from this location.
45      * @return the complete set of classes
46      */
47     public Set JavaDoc<Class JavaDoc> getElements();
48     
49     /**
50      * Sometimes, annotations processing requires more than a single class,
51      * especially when such classes end up being a Java Component (Java Beans,
52      * Java EE). The implementation returned from the getComponent will be
53      * responsible for defining the complete view of this component starting
54      * from it's implementation class.
55      * @param implementation class of the component.
56      */
57     public ComponentInfo getComponentInfo(Class JavaDoc componentImpl);
58     
59 }
60
Popular Tags