1 /* 2 * Copyright (C) 2008 The Guava Authors 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 17 package com.google.common.collect; 18 19 import com.google.common.annotations.GwtCompatible; 20 import java.util.Iterator; 21 22 /** 23 * An iterator that does not support {@link #remove}. 24 * 25 * <p>{@code UnmodifiableIterator} is used primarily in conjunction with implementations of {@link 26 * ImmutableCollection}, such as {@link ImmutableList}. You can, however, convert an existing 27 * iterator to an {@code UnmodifiableIterator} using {@link Iterators#unmodifiableIterator}. 28 * 29 * @author Jared Levy 30 * @since 2.0 31 */ 32 @GwtCompatible 33 public abstract class UnmodifiableIterator<E> implements Iterator<E> { 34 /** Constructor for use by subclasses. */ UnmodifiableIterator()35 protected UnmodifiableIterator() {} 36 37 /** 38 * Guaranteed to throw an exception and leave the underlying data unmodified. 39 * 40 * @throws UnsupportedOperationException always 41 * @deprecated Unsupported operation. 42 */ 43 @Deprecated 44 @Override remove()45 public final void remove() { 46 throw new UnsupportedOperationException(); 47 } 48 } 49