com.davidbracewell.collection.trie.UnmodifiableOrderedMapIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mango Show documentation

A set of utilities and tools to speed up and ease programming in Java.

There is a newer version: 0.5

/*
 * Take from Apache commons
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.davidbracewell.collection.trie;

/**
 * Decorates an ordered map iterator such that it cannot be modified.
 * 
 * Attempts to modify it will result in an UnsupportedOperationException.
 *
 * @version $Id: UnmodifiableOrderedMapIterator.java 1533984 2013-10-20 21:12:51Z tn $
 * @since 3.0
 */
public final class UnmodifiableOrderedMapIterator implements OrderedMapIterator {

  /**
   * The iterator being decorated
   */
  private final OrderedMapIterator iterator;

  //-----------------------------------------------------------------------

  /**
   * Decorates the specified iterator such that it cannot be modified.
   *
   * @param       the key type
   * @param       the value type
   * @param iterator the iterator to decorate
   * @return a new unmodifiable ordered map iterator
   * @throws IllegalArgumentException if the iterator is null
   */
  public static  OrderedMapIterator unmodifiableOrderedMapIterator(
      final OrderedMapIterator iterator) {

    if (iterator == null) {
      throw new IllegalArgumentException("OrderedMapIterator must not be null");
    }
    return new UnmodifiableOrderedMapIterator<>(iterator);
  }

  //-----------------------------------------------------------------------

  /**
   * Constructor.
   *
   * @param iterator the iterator to decorate
   */
  private UnmodifiableOrderedMapIterator(final OrderedMapIterator iterator) {
    super();
    this.iterator = iterator;
  }

  //-----------------------------------------------------------------------
  public boolean hasNext() {
    return iterator.hasNext();
  }

  public K next() {
    return iterator.next();
  }

  public boolean hasPrevious() {
    return iterator.hasPrevious();
  }

  public K previous() {
    return iterator.previous();
  }

  public K getKey() {
    return iterator.getKey();
  }

  public V getValue() {
    return iterator.getValue();
  }

  public V setValue(final V value) {
    throw new UnsupportedOperationException("setValue() is not supported");
  }

  public void remove() {
    throw new UnsupportedOperationException("remove() is not supported");
  }

}