BUG-7464: Add dedicated key set classes
[yangtools.git] / third-party / triemap / src / main / java / org / opendaylight / yangtools / triemap / AbstractKeySet.java
1 /*
2  * (C) Copyright 2016 Pantheon Technologies, s.r.o. and others.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.opendaylight.yangtools.triemap;
17
18 import static com.google.common.base.Preconditions.checkNotNull;
19
20 import java.util.AbstractSet;
21 import java.util.Collection;
22
23 /**
24  * Abstract base class for key set views of a TrieMap
25  *
26  * @author Robert Varga
27  *
28  * @param <K> the type of keys
29  */
30 abstract class AbstractKeySet<K> extends AbstractSet<K> {
31     private final TrieMap<K, ?> map;
32
33     AbstractKeySet(final TrieMap<K, ?> map) {
34         this.map = checkNotNull(map);
35     }
36
37     final TrieMap<K, ?> map() {
38         return map;
39     }
40
41     @Override
42     public final boolean add(final K e) {
43         throw new UnsupportedOperationException();
44     }
45
46     @Override
47     public final boolean addAll(final Collection<? extends K> c) {
48         throw new UnsupportedOperationException();
49     }
50
51     @Override
52     public final boolean contains(final Object o) {
53         return map.containsKey(o);
54     }
55
56     @Override
57     public final boolean isEmpty() {
58         return map.isEmpty();
59     }
60
61     @Override
62     public final int size() {
63         return map.size();
64     }
65 }