| /* |
| * 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 org.apache.commons.collections4.iterators; |
| |
| import java.util.ListIterator; |
| import java.util.Objects; |
| |
| /** |
| * Provides basic behavior for decorating a list iterator with extra functionality. |
| * <p> |
| * All methods are forwarded to the decorated list iterator. |
| * |
| * @since 3.0 |
| */ |
| public class AbstractListIteratorDecorator<E> implements ListIterator<E> { |
| |
| /** The iterator being decorated */ |
| private final ListIterator<E> iterator; |
| |
| //----------------------------------------------------------------------- |
| /** |
| * Constructor that decorates the specified iterator. |
| * |
| * @param iterator the iterator to decorate, must not be null |
| * @throws NullPointerException if the iterator is null |
| */ |
| public AbstractListIteratorDecorator(final ListIterator<E> iterator) { |
| this.iterator = Objects.requireNonNull(iterator, "iterator"); |
| } |
| |
| /** |
| * Gets the iterator being decorated. |
| * |
| * @return the decorated iterator |
| */ |
| protected ListIterator<E> getListIterator() { |
| return iterator; |
| } |
| |
| //----------------------------------------------------------------------- |
| |
| /** {@inheritDoc} */ |
| @Override |
| public boolean hasNext() { |
| return iterator.hasNext(); |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| public E next() { |
| return iterator.next(); |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| public int nextIndex() { |
| return iterator.nextIndex(); |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| public boolean hasPrevious() { |
| return iterator.hasPrevious(); |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| public E previous() { |
| return iterator.previous(); |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| public int previousIndex() { |
| return iterator.previousIndex(); |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| public void remove() { |
| iterator.remove(); |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| public void set(final E obj) { |
| iterator.set(obj); |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| public void add(final E obj) { |
| iterator.add(obj); |
| } |
| |
| } |