01: /* ====================================================================
02: The Jicarilla Software License
03:
04: Copyright (c) 2003 Leo Simons.
05: All rights reserved.
06:
07: Permission is hereby granted, free of charge, to any person obtaining
08: a copy of this software and associated documentation files (the
09: "Software"), to deal in the Software without restriction, including
10: without limitation the rights to use, copy, modify, merge, publish,
11: distribute, sublicense, and/or sell copies of the Software, and to
12: permit persons to whom the Software is furnished to do so, subject to
13: the following conditions:
14:
15: The above copyright notice and this permission notice shall be
16: included in all copies or substantial portions of the Software.
17:
18: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21: IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22: CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23: TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24: SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25: ==================================================================== */
26: package org.jicarilla.container;
27:
28: import org.jicarilla.lang.Switch;
29:
30: /**
31: * Represents the contract between a {@link DefaultContainer} or
32: * {@link DefaultKeyRelayingContainer} and the associated {@link Resolver}.
33: * This class is not part of the public API on purpose -- it is an
34: * implementation detail associated with the way the default implementation
35: * package divides functionality.
36: *
37: * @author <a href="mail at leosimons dot com">Leo Simons</a>
38: * @version $Id: ResolverCallback.java,v 1.3 2004/03/23 13:37:51 lsimons Exp $
39: */
40: public interface ResolverCallback {
41: /**
42: * Called by the resolver to retrieve a reference to the {@link Switch}
43: * that contains the mapping from keys to adapters used by the container.
44: * The reference that is retrieved should not be stored in the resolver.
45: *
46: * @return the reference to the switch that contains the mapping from keys
47: * to adapters used by the container.
48: */
49: Switch getSwitch();
50:
51: /**
52: * Called by the resolver whenever it retrieves an instance from an
53: * adapter that it retrieved from the switch provided by
54: * {@link #getSwitch()}.
55: *
56: * @param instance the instance that was retrieved.
57: * @param adapter the adapter from which the instance was retrieved.
58: */
59: void providedInstance(Object instance, Object adapter);
60:
61: /**
62: * Called by the resolver whenever an instance retrieved from an adapter
63: * that was retrieved from the switch provided by {@link #getSwitch()}
64: * needs to be returned.
65: *
66: * @param instance the instance that was retrieved.
67: * @throws Exception if {@link Adapter#releaseInstance(Object)}
68: * throws an exception. The container should not normally throw
69: * an Exception otherwise.
70: */
71: void returnedInstance(Object instance) throws Exception;
72: }
|