aermicioi.aedi.storage.storage 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.storage.storage;
32 
33 import aermicioi.aedi.storage.locator;
34 
35 /**
36 Interface for objects that are able to store elements of Type by identity of KeyType.
37 **/
38 @safe interface Storage(Type, KeyType) {
39 
40     public {
41 
42 		/**
43 		Save an element in Storage by key identity.
44 
45 		Params:
46 			identity = identity of element in Storage.
47 			element = element which is to be saved in Storage.
48 
49 		Return:
50 			Storage
51 		**/
52         Storage set(Type element, KeyType identity);
53 
54         /**
55         Remove an element from Storage with identity.
56 
57         Remove an element from Storage with identity. If there is no element by provided identity, then no action is performed.
58 
59         Params:
60         	identity = the identity of element to be removed.
61 
62     	Return:
63     		Storage
64         **/
65         Storage remove(KeyType identity);
66     }
67 }
68 
69 /**
70  ditto
71 **/
72 alias Aggregator(Type = Object, KeyType = string, StorageIdentityType = KeyType) = Storage!(Type, KeyType);
73 
74 /**
75 Mix in storage interface implementation that delegates
76 the logic to decorated container.
77 **/
78 @safe mixin template StorageMixin(T : Storage!(W, X), W, X) {
79     /**
80     Set component in decorated by identity.
81 
82     Params:
83         identity = identity of factory.
84         element = factory that is to be saved in decorated.
85 
86     Return:
87         SwitchableContainer!T decorating decorated.
88     **/
89     T set(W element, X identity)
90     in(decorated !is null, "Cannot store component in decorated component container, when no container to decorate is provided")
91     {
92         this.decorated.set(element, identity);
93 
94         return this;
95     }
96 
97     /**
98     Remove factory from decorated with identity.
99 
100     Remove factory from decorated with identity.
101 
102     Params:
103         identity = the identity of factory to be removed.
104 
105     Return:
106         SwitchableContainer!T decorating decorated
107     **/
108     T remove(X identity)
109     in(decorated !is null, "Cannot remove component in decorated component container, when no container to decorate is provided")
110     {
111         decorated.remove(identity);
112 
113         return this;
114     }
115 }