third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/TrieMapReadOnlyIterator.java

   1 /*
   2  * (C) Copyright 2017 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 java.util.Map.Entry;
  19
  20 /**
  21  * This iterator is a read-only one and does not allow for any update
  22  * operations on the underlying data structure.
  23  *
  24  * @param <K> the type of keys
  25  * @param <V> the type of values
  26  */
  27 final class TrieMapReadOnlyIterator<K, V> extends TrieMapIterator<K, V> {
  28     TrieMapReadOnlyIterator (final int level, final TrieMap<K, V> ct, final boolean mustInit) {
  29         super (level, ct, mustInit);
  30     }
  31
  32     TrieMapReadOnlyIterator (final int level, final TrieMap<K, V> ct) {
  33         this (level, ct, true);
  34     }
  35     @Override
  36     void initialize () {
  37         assert (ct.isReadOnly ());
  38         super.initialize ();
  39     }
  40
  41     @Override
  42     public void remove () {
  43         throw new UnsupportedOperationException ("Operation not supported for read-only iterators");
  44     }
  45
  46     @Override
  47     Entry<K, V> nextEntry(final Entry<K, V> rr) {
  48         // Return non-updatable entry
  49         return rr;
  50     }
  51 }