01: /*
02: * Copyright (c) 2001-2007, Jean Tessier
03: * All rights reserved.
04: *
05: * Redistribution and use in source and binary forms, with or without
06: * modification, are permitted provided that the following conditions
07: * are met:
08: *
09: * * 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.io.*;
36: import java.util.*;
37:
38: /**
39: * Base interface for parsing <code>.class</code> files.
40: * This should have been a Java interface, but I needed
41: * the protected contract for the Decorator Pattern.
42: *
43: * @see ClassfileLoaderDecorator
44: */
45: public abstract class ClassfileLoader {
46: // Main methods
47: public abstract Classfile getClassfile(String name);
48:
49: public abstract Collection<Classfile> getAllClassfiles();
50:
51: public abstract Collection<String> getAllClassNames();
52:
53: public void load(Collection<String> filenames) {
54: fireBeginSession();
55:
56: for (String filename : filenames) {
57: load(filename);
58: }
59:
60: fireEndSession();
61: }
62:
63: // Protected contract for Decorator Pattern
64: protected abstract void load(String filename);
65:
66: protected abstract void load(String filename, InputStream in);
67:
68: protected abstract Classfile load(DataInputStream in)
69: throws IOException;
70:
71: // Event stuff
72: public abstract void addLoadListener(LoadListener listener);
73:
74: public abstract void removeLoadListener(LoadListener listener);
75:
76: protected abstract void fireBeginSession();
77:
78: protected abstract void fireBeginGroup(String group_name, int size);
79:
80: protected abstract void fireBeginClassfile(String filename);
81:
82: protected abstract void fireBeginFile(String filename);
83:
84: protected abstract void fireEndClassfile(String filename,
85: Classfile classfile);
86:
87: protected abstract void fireEndFile(String filename);
88:
89: protected abstract void fireEndGroup(String group_name);
90:
91: protected abstract void fireEndSession();
92: }
|