summaryrefslogtreecommitdiff
path: root/platform/util/src/com/intellij/util/containers/FactoryMap.java
blob: 30684d0e6dfa437da92cf8975382069ad296bcab (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
/*
 * Copyright 2000-2013 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.util.containers;

import gnu.trove.THashMap;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.*;

import static com.intellij.util.ObjectUtils.NULL;

/**
 * @author peter
 */
public abstract class FactoryMap<K,V> implements Map<K, V> {
  protected Map<K,V> myMap;

  protected Map<K, V> createMap() {
    return new THashMap<K, V>();
  }

  @Nullable
  protected abstract V create(K key);

  private Map<K, V> getMap() {
    if (myMap == null) {
      myMap = createMap();
    }
    return myMap;
  }
  
  @Override
  public V get(Object key) {
    final Map<K, V> map = getMap();
    V value = map.get(getKey(key));
    if (value == null) {
      value = create((K)key);
      map.put((K)getKey(key), value == null ? (V)NULL : value);
    }
    return value == NULL ? null : value;
  }

  private static <K> K getKey(final K key) {
    return key == null ? (K)NULL : key;
  }

  @Override
  public final boolean containsKey(Object key) {
    return myMap != null && myMap.containsKey(getKey(key));
  }

  @Override
  public V put(K key, V value) {
    V v = getMap().put(getKey(key), value == null ? (V)NULL : value);
    return v == NULL ? null : v;
  }

  @Override
  public V remove(Object key) {
    if (myMap == null) return null;
    V v = myMap.remove(key);
    return v == NULL ? null : v;
  }

  @NotNull
  @Override
  public Set<K> keySet() {
    if (myMap == null) return Collections.emptySet();
    final Set<K> ts = myMap.keySet();
    if (ts.contains(NULL)) {
      final HashSet<K> hashSet = new HashSet<K>(ts);
      hashSet.remove(NULL);
      hashSet.add(null);
      return hashSet;
    }
    return ts;
  }

  public Collection<V> notNullValues() {
    if (myMap == null) return Collections.emptyList();
    final Collection<V> values = new ArrayList<V>(myMap.values());
    for (Iterator<V> iterator = values.iterator(); iterator.hasNext();) {
      if (iterator.next() == NULL) {
        iterator.remove();
      }
    }
    return values;
  }

  @Override
  public void clear() {
    if (myMap != null) {
      myMap.clear();
    }
  }

  @Override
  public int size() {
    if (myMap == null) return 0;
    return myMap.size();
  }

  @Override
  public boolean isEmpty() {
    return myMap == null || myMap.isEmpty();
  }

  @Override
  public boolean containsValue(final Object value) {
    return myMap != null && myMap.containsValue(value);
  }

  @Override
  public void putAll(@NotNull final Map<? extends K, ? extends V> m) {
    for (Entry<? extends K, ? extends V> entry : m.entrySet()) {
      put(entry.getKey(), entry.getValue());
    }
  }

  @NotNull
  @Override
  public Collection<V> values() {
    if (myMap == null) return Collections.emptyList();
    return myMap.values();
  }

  @NotNull
  @Override
  public Set<Entry<K, V>> entrySet() {
    if (myMap == null) return Collections.emptySet();
    return myMap.entrySet();
  }
}