summaryrefslogtreecommitdiff
path: root/src/main/java/bjc/funcdata/ExtendedMap.java
blob: 800cfaad69b09cf1e320626416d148db94a4f5fc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/* 
 * esodata - data structures and other things, of varying utility
 * Copyright 2022, Ben Culkin
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *   
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package bjc.funcdata;

import java.util.*;
import java.util.function.*;

/**
 * An extended version of a map, that stores values into a map, but can look
 * into a different one for others.
 *
 * @author Ben Culkin
 *
 * @param <KeyType>
 *                    The type of the keys of the map.
 *
 * @param <ValueType>
 *                    The type of the values of the map.
 */
class ExtendedMap<KeyType, ValueType> implements MapEx<KeyType, ValueType> {
	/* The map we delegate lookups to. */
	private final MapEx<KeyType, ValueType> delegate;
	/* The map we store things in. */
	private final MapEx<KeyType, ValueType> store;

	private boolean isFrozen     = false;
	private boolean thawEnabled  = true;
	
	/**
	 * Create a new extended map.
	 *
	 * @param delegate
	 *                 The map to lookup things in.
	 *
	 * @param store
	 *                 The map to store things in.
	 */
	public ExtendedMap(final MapEx<KeyType, ValueType> delegate,
			final MapEx<KeyType, ValueType> store) {
		this.delegate = delegate;
		this.store = store;
	}

	@Override
	public void clear() {
		if (isFrozen) return;
		
		store.clear();
	}

	@Override
	public boolean containsKey(final KeyType key) {
		if (store.containsKey(key)) return true;
		
		return delegate.containsKey(key);
	}

	@Override
	public void forEach(final BiConsumer<KeyType, ValueType> action) {
		store.forEach(action);

		delegate.forEach(action);
	}

	@Override
	public Optional<ValueType> get(final KeyType key) {
		if (store.containsKey(key)) return store.get(key);
		
		return delegate.get(key);
	}

	@Override
	public int size() {
		return store.size() + delegate.size();
	}

	@Override
	public ListEx<KeyType> keyList() {
		ListEx<KeyType> ilst = new FunctionalList<>();

		ilst.addAll(store.keyList());
		ilst.addAll(delegate.keyList());

		return ilst;
	}

	@Override
	public ValueType put(final KeyType key, final ValueType val) {
		if (isFrozen)
			throw new ObjectFrozen("Can't insert key " + key + " into frozen map");
		
		return store.put(key, val);
	}

	@Override
	public ValueType remove(final KeyType key) {
		if (isFrozen)
			throw new ObjectFrozen("Can't remove key " + key + " from frozen map");
		
		if (!store.containsKey(key)) return delegate.remove(key);
		
		return store.remove(key);
	}

	@Override
  public int hashCode() {
		// isFrozen isn't counted
    return Objects.hash(delegate, store);
  }

	/* Misc. object support. */
  @Override
  public boolean equals(Object obj) {
  	if (this == obj)                  return true;
    if (obj == null)                  return false;
    if (getClass() != obj.getClass()) return false;

    ExtendedMap<?, ?> other = (ExtendedMap<?, ?>) obj;

		// isFrozen isn't counted
    return Objects.equals(delegate, other.delegate) && Objects.equals(store, other.store);
  }

  @Override
	public String toString() {
		return String.format("ExtendedMap [delegate=%s, store=%s]", delegate, store);
	}

  /* IFreezable support */
  
	@Override
	public boolean freeze() {
			isFrozen = true;
			
			return true;
	}

	@Override
	public boolean deepFreeze() {
  	thawEnabled  = false;

  	return freeze();
	}
	
	@Override
	public boolean thaw() {
		if (thawEnabled) {
			isFrozen = false;
			return true;
		}
		
		return false;
	}

	@Override
	public boolean isFrozen() {
		return isFrozen;
	}
	
	@Override
	public boolean canFreeze() {
		return true;
	}
	
	@Override
	public boolean canThaw() {
		return thawEnabled;
	}
}