diff options
Diffstat (limited to 'subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/matchers/util/CollectionsFactory.java')
-rw-r--r-- | subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/matchers/util/CollectionsFactory.java | 188 |
1 files changed, 188 insertions, 0 deletions
diff --git a/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/matchers/util/CollectionsFactory.java b/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/matchers/util/CollectionsFactory.java new file mode 100644 index 00000000..590a1ec3 --- /dev/null +++ b/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/matchers/util/CollectionsFactory.java | |||
@@ -0,0 +1,188 @@ | |||
1 | /******************************************************************************* | ||
2 | * Copyright (c) 2010-2013, Istvan Rath and Daniel Varro | ||
3 | * This program and the accompanying materials are made available under the | ||
4 | * terms of the Eclipse Public License v. 2.0 which is available at | ||
5 | * http://www.eclipse.org/legal/epl-v20.html. | ||
6 | * | ||
7 | * SPDX-License-Identifier: EPL-2.0 | ||
8 | *******************************************************************************/ | ||
9 | package tools.refinery.viatra.runtime.matchers.util; | ||
10 | |||
11 | import java.util.Collection; | ||
12 | import java.util.List; | ||
13 | import java.util.Map; | ||
14 | import java.util.Set; | ||
15 | import java.util.TreeMap; | ||
16 | import java.util.function.Function; | ||
17 | |||
18 | /** | ||
19 | * Factory class used as an accessor to Collections implementations. | ||
20 | * @author istvanrath | ||
21 | */ | ||
22 | public final class CollectionsFactory | ||
23 | { | ||
24 | |||
25 | /** | ||
26 | * Instantiates a new empty map. | ||
27 | * @since 1.7 | ||
28 | */ | ||
29 | public static <K, V> Map<K, V> createMap() { | ||
30 | return FRAMEWORK.createMap(); | ||
31 | } | ||
32 | |||
33 | /** | ||
34 | * Instantiates a new map with the given initial contents. | ||
35 | * @since 1.7 | ||
36 | */ | ||
37 | public static <K, V> Map<K, V> createMap(Map<K, V> initial) { | ||
38 | return FRAMEWORK.createMap(initial); | ||
39 | } | ||
40 | |||
41 | /** | ||
42 | * Instantiates a new tree map. | ||
43 | * @since 2.3 | ||
44 | */ | ||
45 | public static <K, V> TreeMap<K, V> createTreeMap() { | ||
46 | return FRAMEWORK.createTreeMap(); | ||
47 | } | ||
48 | |||
49 | /** | ||
50 | * Instantiates a new empty set. | ||
51 | * @since 1.7 | ||
52 | */ | ||
53 | public static <E> Set<E> createSet() { | ||
54 | return FRAMEWORK.createSet(); | ||
55 | } | ||
56 | |||
57 | /** | ||
58 | * Instantiates a new set with the given initial contents. | ||
59 | * @since 1.7 | ||
60 | */ | ||
61 | public static <E> Set<E> createSet(Collection<E> initial) { | ||
62 | return FRAMEWORK.createSet(initial); | ||
63 | } | ||
64 | |||
65 | /** | ||
66 | * Instantiates an empty set; the key parameter is used to allow using this as a method reference as a | ||
67 | * {@link Function}, e.g. in {@link Map#computeIfAbsent(Object, Function)}. | ||
68 | * | ||
69 | * @param key | ||
70 | * the value of this parameter is ignored | ||
71 | * @since 2.0 | ||
72 | */ | ||
73 | public static <T> Set<T> emptySet(Object key) { | ||
74 | return FRAMEWORK.createSet(); | ||
75 | } | ||
76 | |||
77 | /** | ||
78 | * Instantiates a new empty multiset. | ||
79 | * @since 1.7 | ||
80 | */ | ||
81 | public static <T> IMultiset<T> createMultiset() { | ||
82 | return FRAMEWORK.createMultiset(); | ||
83 | } | ||
84 | |||
85 | /** | ||
86 | * Instantiates an empty multiset; the key parameter is used to allow using this as a method reference as a | ||
87 | * {@link Function}, e.g. in {@link Map#computeIfAbsent(Object, Function)}. | ||
88 | * | ||
89 | * @param key | ||
90 | * the value of this parameter is ignored | ||
91 | * @since 2.0 | ||
92 | */ | ||
93 | public static <T> IMultiset<T> emptyMultiset(Object key) { | ||
94 | return FRAMEWORK.createMultiset(); | ||
95 | } | ||
96 | |||
97 | /** | ||
98 | * Instantiates a new empty delta bag. | ||
99 | * @since 1.7 | ||
100 | */ | ||
101 | public static <T> IDeltaBag<T> createDeltaBag() { | ||
102 | return FRAMEWORK.createDeltaBag(); | ||
103 | } | ||
104 | |||
105 | /** | ||
106 | * Instantiates a new list that is optimized for registering observers / callbacks. | ||
107 | * @since 1.7 | ||
108 | */ | ||
109 | public static <O> List<O> createObserverList() { | ||
110 | return FRAMEWORK.createObserverList(); | ||
111 | } | ||
112 | |||
113 | /** | ||
114 | * Instantiates a size-optimized multimap from keys to sets of values. | ||
115 | * <p>For a single key, many values can be associated according to the given bucket semantics. | ||
116 | * <p>The keys and values are stored as type fromKeys resp. ofValues; | ||
117 | * currently Object.class and Long.class are supported. | ||
118 | * @since 2.0 | ||
119 | */ | ||
120 | public static <K, V> IMultiLookup<K, V> createMultiLookup( | ||
121 | Class<? super K> fromKeys, MemoryType toBuckets, Class<? super V> ofValues) { | ||
122 | return FRAMEWORK.createMultiLookup(fromKeys, toBuckets, ofValues); | ||
123 | } | ||
124 | |||
125 | /** | ||
126 | * Instantiates a memory storing values. | ||
127 | * <p>For a single key, many values can be associated according to the given memory semantics. | ||
128 | * <p>The values are stored as type 'values'; | ||
129 | * currently Object.class and Long.class are supported. | ||
130 | * @since 2.0 | ||
131 | */ | ||
132 | public static <T> IMemory<T> createMemory( | ||
133 | Class<? super T> values, MemoryType memoryType) { | ||
134 | return FRAMEWORK.createMemory(values, memoryType); | ||
135 | } | ||
136 | |||
137 | /** | ||
138 | * The type of {@link IMemory} | ||
139 | * @since 2.0 | ||
140 | * TODO add delta as type | ||
141 | */ | ||
142 | public enum MemoryType { | ||
143 | /** | ||
144 | * A single key-value pair is stored at most once | ||
145 | */ | ||
146 | SETS, | ||
147 | /** | ||
148 | * Duplicate key-value pairs allowed | ||
149 | */ | ||
150 | MULTISETS | ||
151 | } | ||
152 | |||
153 | /** | ||
154 | * The collections framework of the current configuration. | ||
155 | * @since 1.7 | ||
156 | */ | ||
157 | private static final ICollectionsFramework FRAMEWORK = new EclipseCollectionsFactory(); | ||
158 | |||
159 | /** | ||
160 | * Interface abstracting over a collections technology that provides custom collection implementations. | ||
161 | * @since 1.7 | ||
162 | */ | ||
163 | public static interface ICollectionsFramework { | ||
164 | |||
165 | public abstract <K,V> Map<K,V> createMap(); | ||
166 | public abstract <K,V> Map<K,V> createMap(Map<K,V> initial); | ||
167 | /** | ||
168 | * @since 2.3 | ||
169 | */ | ||
170 | public abstract <K, V> TreeMap<K, V> createTreeMap(); | ||
171 | public abstract <E> Set<E> createSet(); | ||
172 | public abstract <E> Set<E> createSet(Collection<E> initial); | ||
173 | public abstract <T> IMultiset<T> createMultiset(); | ||
174 | public abstract <T> IDeltaBag<T> createDeltaBag(); | ||
175 | public abstract <O> List<O> createObserverList(); | ||
176 | |||
177 | /** | ||
178 | * @since 2.0 | ||
179 | */ | ||
180 | public abstract <K, V> IMultiLookup<K, V> createMultiLookup( | ||
181 | Class<? super K> fromKeys, MemoryType toBuckets, Class<? super V> ofValues); | ||
182 | /** | ||
183 | * @since 2.0 | ||
184 | */ | ||
185 | public abstract <T> IMemory<T> createMemory(Class<? super T> values, MemoryType memoryType); | ||
186 | } | ||
187 | |||
188 | } \ No newline at end of file | ||