KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > logicalcobwebs > cglib > proxy > Factory


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 2002 The Apache Software Foundation. All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by the
22  * Apache Software Foundation (http://www.apache.org/)."
23  * Alternately, this acknowledgment may appear in the software itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Apache" and "Apache Software Foundation" must
27  * not be used to endorse or promote products derived from this
28  * software without prior written permission. For written
29  * permission, please contact apache@apache.org.
30  *
31  * 5. Products derived from this software may not be called "Apache",
32  * nor may "Apache" appear in their name, without prior written
33  * permission of the Apache Software Foundation.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Apache Software Foundation. For more
51  * information on the Apache Software Foundation, please see
52  * <http://www.apache.org/>.
53  */

54
55 package org.logicalcobwebs.cglib.proxy;
56
57 /**
58  * All enhanced instances returned by the {@link Enhancer} class implement this interface.
59  * Using this interface for new instances is faster than going through the <code>Enhancer</code>
60  * interface or using reflection. In addition, to intercept methods called during
61  * object construction you <b>must</b> use these methods instead of reflection.
62  * @author Juozas Baliuka <a HREF="mailto:baliuka@mwm.lt">baliuka@mwm.lt</a>
63  * @version $Id: Factory.java,v 1.1 2003/12/12 19:28:11 billhorsman Exp $
64  */

65 public interface Factory {
66     /**
67      * Creates new instance of the same type, using the no-arg
68      * contructor, and copying the callbacks from the existing instance.
69      * @return new instance of the same type
70      */

71     Object JavaDoc newInstance();
72
73     /**
74      * Creates new instance of the same type, using the no-arg constructor.
75      * The class of this object must have been created using a single Callback type.
76      * If multiple callbacks are required an exception will be thrown.
77      * @param callback the new interceptor to use
78      * @return new instance of the same type
79      */

80     Object JavaDoc newInstance(Callback callback);
81     
82     /**
83      * Creates new instance of the same type, using the no-arg constructor.
84      * @param callbacks the new callbacks(s) to use
85      * @return new instance of the same type
86      */

87     Object JavaDoc newInstance(Callback[] callbacks);
88
89     /**
90      * Creates a new instance of the same type, using the constructor
91      * matching the given signature, and copying the callbacks
92      * from the existing instance.
93      * @param types the constructor argument types
94      * @param args the constructor arguments
95      * @return new instance of the same type
96      */

97     Object JavaDoc newInstance(Class JavaDoc[] type, Object JavaDoc[] args);
98
99     /**
100      * Creates a new instance of the same type, using the constructor
101      * matching the given signature.
102      * @param types the constructor argument types
103      * @param args the constructor arguments
104      * @param callbacks the new interceptor(s) to use
105      * @return new instance of the same type
106      */

107     Object JavaDoc newInstance(Class JavaDoc[] types, Object JavaDoc[] args, Callback[] callbacks);
108
109     /**
110      * Return the <code>Callback</code> implementation at the specified index.
111      * @param index the callback index
112      * @return the callback implementation
113      */

114     Callback getCallback(int index);
115
116     /**
117      * Set the callback for this object for the given type.
118      * @param index the callback index to replace
119      * @param callback the new callback
120      */

121     void setCallback(int index, Callback callback);
122
123     /**
124      * Replace all of the callbacks for this object at once.
125      * @param callbacks the new callbacks(s) to use
126      */

127     void setCallbacks(Callback[] callbacks);
128 }
129
Popular Tags