KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jeantessier > classreader > LoadListener


1 /*
2  * Copyright (c) 2001-2005, Jean Tessier
3  * All rights reserved.
4  *
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  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Jean Tessier nor the names of his contributors
17  * may be used to endorse or promote products derived from this software
18  * 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 REGENTS OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 package com.jeantessier.classreader;
34
35 import java.util.*;
36
37 public interface LoadListener extends EventListener {
38     public void beginSession(LoadEvent event);
39
40     /**
41      * <p>The loader is starting on a new group of files.
42      * For example, this can be a new JAR file or a
43      * collection of loose <code>.class</code> files.</p>
44      *
45      * <p>The event's filename attribute points to the source
46      * or the group of files, such as the JAR file's name
47      * or the root directory of the loose files.</p>
48      *
49      * <p>The element and classfile attributes are null.</p>
50      */
51     public void beginGroup(LoadEvent event);
52     
53     /**
54      * <p>The loader is starting on a new file.</p>
55      *
56      * <p>The event's element attribute contains the name of
57      * the file being processed.</p>
58      *
59      * <p>The event's filename attribute points to the group
60      * of files that contains the current file. For
61      * example, the JAR file's name or the root directory
62      * of loose files.</p>
63      *
64      * <p>The classfile attribute is null.</p>
65      */
66     public void beginFile(LoadEvent event);
67     
68     /**
69      * <p>The loader is starting on a new <code>.class</code>
70      * file.</p>
71      *
72      * <p>The event's element attribute contains the name of
73      * the <code>.class</code> file being processed.</p>
74      *
75      * <p>The event's filename attribute points to the group
76      * of files that contains the current file. For
77      * example, the JAR file's name or the root directory
78      * of loose files.</p>
79      *
80      * <p>The classfile attribute is null.</p>
81      */
82     public void beginClassfile(LoadEvent event);
83     
84     /**
85      * <p>The loader is finished loading a <code>.class</code>
86      * file.</p>
87      *
88      * <p>The event's classfile attribute contains the newly
89      * loaded Classfile instance from the <code>.class</code>
90      * file.</p>
91      *
92      * <p>The event's filename attribute points to the group
93      * of files that contains the current file. For
94      * example, the JAR file's name or the root directory
95      * of loose files.</p>
96      *
97      * <p>The element attribute is null.</p>
98      */
99     public void endClassfile(LoadEvent event);
100     
101     /**
102      * <p>The loader is finished with a file.</p>
103      *
104      * <p>The event's element attribute contains the name of
105      * the file being processed.</p>
106      *
107      * <p>The event's filename attribute points to the group
108      * of files that contains the current file. For
109      * example, the JAR file's name or the root directory
110      * of loose files.</p>
111      *
112      * <p>The event's classfile attribute may contains a newly
113      * loaded Classfile instance from the file.</p>
114      */
115     public void endFile(LoadEvent event);
116
117     /**
118      * <p>The loader finished the group of files. For
119      * example, this can be a new JAR file or a
120      * collection of loose <code>.class</code> files.</p>
121      *
122      * <p>The event's filename attribute points to the source
123      * or the group of files, such as the JAR file's name
124      * or the root directory of the loose files.</p>
125      *
126      * <p>The element and classfile attributes are null.</p>
127      */
128     public void endGroup(LoadEvent event);
129
130     public void endSession(LoadEvent event);
131 }
132
Popular Tags