aermicioi.aedi.container.container source code

1 /**
2 
3 License:
4 	Boost Software License - Version 1.0 - August 17th, 2003
5     
6     Permission is hereby granted, free of charge, to any person or organization
7     obtaining a copy of the software and accompanying documentation covered by
8     this license (the "Software") to use, reproduce, display, distribute,
9     execute, and transmit the Software, and to prepare derivative works of the
10     Software, and to permit third-parties to whom the Software is furnished to
11     do so, all subject to the following:
12     
13     The copyright notices in the Software and this entire statement, including
14     the above license grant, this restriction and the following disclaimer,
15     must be included in all copies of the Software, in whole or in part, and
16     all derivative works of the Software, unless such copies or derivative
17     works are solely in the form of machine-executable object code generated by
18     a source language processor.
19     
20     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22     FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
23     SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
24     FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
25     ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
26     DEALINGS IN THE SOFTWARE.
27 
28 Authors:
29 	Alexandru Ermicioi
30 **/
31 module aermicioi.aedi.container.container;
32 
33 import aermicioi.aedi.factory.factory;
34 import aermicioi.aedi.storage.locator;
35 import aermicioi.aedi.storage.storage;
36 import aermicioi.aedi.storage.alias_aware;
37 
38 /**
39 Interface for objects that instantiate and manage the lifetime of objects in it.
40 **/
41 interface Container : Locator!(Object, string) {
42 
43     public {
44         
45         /**
46         Sets up the internal state of container.
47         
48         Sets up the internal state of container (Ex, for singleton container it will spawn all objects that locator contains).
49         **/
50         Container instantiate();
51     }
52 }
53 
54 /**
55  Buildable/configurable instantiatiator with factories, and aliasing. 
56 **/
57 interface ConfigurableContainer : Container, Storage!(ObjectFactory, string), AliasAware!(string), FactoryLocator!ObjectFactory {
58 	
59 }
60 
61 /**
62 Provide an interface for accessing factories used by containers to instantiate data.
63 **/
64 interface FactoryLocator(T : Factory!Z, Z) {
65     import std.range.interfaces;
66     import std.typecons;
67     
68     public {
69         
70         /**
71         Get factory for constructed data identified by identity.
72         
73         Get factory for constructed data identified by identity.
74         Params:
75         	identity = the identity of data that factory constructs.
76         
77         Throws:
78         	NotFoundException when factory for it is not found.
79         
80         Returns:
81         	T the factory for constructed data.
82         **/
83         T getFactory(string identity);
84         
85         /**
86         Get all factories available in container.
87         
88         Get all factories available in container.
89         
90         Returns:
91         	InputRange!(Tuple!(T, string)) a tuple of factory => identity.
92         **/
93         InputRange!(Tuple!(T, string)) getFactories();
94     }
95 }