01: // Copyright 2006, 2007 The Apache Software Foundation
02: //
03: // Licensed under the Apache License, Version 2.0 (the "License");
04: // you may not use this file except in compliance with the License.
05: // You may obtain a copy of the License at
06: //
07: // http://www.apache.org/licenses/LICENSE-2.0
08: //
09: // Unless required by applicable law or agreed to in writing, software
10: // distributed under the License is distributed on an "AS IS" BASIS,
11: // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12: // See the License for the specific language governing permissions and
13: // limitations under the License.
14:
15: package org.apache.tapestry.ioc.services;
16:
17: import java.lang.reflect.Constructor;
18: import java.lang.reflect.Method;
19:
20: import org.apache.tapestry.ioc.Location;
21:
22: /**
23: * Service used when dynamically creating new classes.
24: */
25: public interface ClassFactory {
26: /**
27: * Simplified version of {@link #newClass(String, Class)} that generates a name based on the
28: * service interface name, extends from java.lang.Object, and automatically adds the
29: * serviceInterface to the returned ClassFab. This is the most common use when creating the
30: * kinds of proxies used throughout Tapestry IoC.
31: *
32: * @param serviceInterface
33: */
34: ClassFab newClass(Class serviceInterface);
35:
36: /**
37: * Creates a {@link ClassFab} object for the given name; the new class is a subclass of the
38: * indicated class. The new class is always public and concrete.
39: *
40: * @param name
41: * the full qualified name of the class to create (note that it is common to place
42: * created classes in the default package)
43: * @param superClass
44: * the parent class, which is often java.lang.Object
45: */
46:
47: ClassFab newClass(String name, Class super Class);
48:
49: /**
50: * Imports the class to make it referenceable within the factory. The class loader for the class
51: * is added to the class path. The class itself is returned, if its bytecode is available. If
52: * not, a search up the inhertance occurs until a proper class (that can be referenced in
53: * generated bytecode) is found. This is necessary to handle cases where a class is generated at
54: * runtime, outside of the class factory, and bytecode is not available for it.
55: *
56: * @param clazz
57: * @return a referencable super-class
58: */
59: Class importClass(Class clazz);
60:
61: /**
62: * Returns the number of classes (and interfaces) actually created.
63: */
64:
65: int getCreatedClassCount();
66:
67: /**
68: * Returns the class loader used when creating new classes; this is generally the same as the
69: * current thread's context class loader (except perhaps during testing).
70: */
71: ClassLoader getClassLoader();
72:
73: /**
74: * Converts a method to a {@link MethodLocation}, which includes information about the source
75: * file name and line number.
76: *
77: * @param method
78: * to look up
79: * @return the location, or null if the necessary information is not available
80: */
81: Location getMethodLocation(Method method);
82:
83: /**
84: * Return a string representation fo the constructor (including class and parameters) and (if
85: * available) file name and line number.
86: */
87: Location getConstructorLocation(Constructor constructor);
88: }
|