    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      https://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.collections4.iterators;
    018
    019import java.util.Iterator;
    020import java.util.Objects;
    021
    022/**
    023 * Provides basic behavior for decorating an iterator with extra functionality without committing the generic type of the Iterator implementation.
    024 * <p>
    025 * All methods are forwarded to the decorated iterator.
    026 * </p>
    027 *
    028 * @param <I> The type of the iterator being decorated.
    029 * @param <O> The type of elements returned by this iterator.
    030 * @since 4.0
    031 */
    032public abstract class AbstractUntypedIteratorDecorator<I, O> implements Iterator<O> {
    033
    034    /** The iterator being decorated */
    035    private final Iterator<I> iterator;
    036
    037    /**
    038     * Create a new AbstractUntypedIteratorDecorator.
    039     *
    040     * @param iterator  The iterator to decorate
    041     * @throws NullPointerException if the iterator is null
    042     */
    043    protected AbstractUntypedIteratorDecorator(final Iterator<I> iterator) {
    044        this.iterator = Objects.requireNonNull(iterator, "iterator");
    045    }
    046
    047    /**
    048     * Gets the iterator being decorated.
    049     *
    050     * @return The decorated iterator
    051     */
    052    protected Iterator<I> getIterator() {
    053        return iterator;
    054    }
    055
    056    @Override
    057    public boolean hasNext() {
    058        return iterator.hasNext();
    059    }
    060
    061    @Override
    062    public void remove() {
    063        iterator.remove();
    064    }
    065
    066}