com.groupbyinc.common.apache.commons.collections4.iterators.AbstractOrderedMapIteratorDecorator Maven / Gradle / Ivy
/*
* 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 org.apache.commons.collections4.OrderedMapIterator;
/**
* Provides basic behaviour for decorating an ordered map iterator with extra functionality.
*
* All methods are forwarded to the decorated map iterator.
*
* @since 3.0
* @version $Id: AbstractOrderedMapIteratorDecorator.java 1686855 2015-06-22 13:00:27Z tn $
*/
public class AbstractOrderedMapIteratorDecorator implements OrderedMapIterator {
/** The iterator being decorated */
private final OrderedMapIterator 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 AbstractOrderedMapIteratorDecorator(final OrderedMapIterator iterator) {
super();
if (iterator == null) {
throw new NullPointerException("OrderedMapIterator must not be null");
}
this.iterator = iterator;
}
/**
* Gets the iterator being decorated.
*
* @return the decorated iterator
*/
protected OrderedMapIterator getOrderedMapIterator() {
return iterator;
}
//-----------------------------------------------------------------------
/** {@inheritDoc} */
public boolean hasNext() {
return iterator.hasNext();
}
/** {@inheritDoc} */
public K next() {
return iterator.next();
}
/** {@inheritDoc} */
public boolean hasPrevious() {
return iterator.hasPrevious();
}
/** {@inheritDoc} */
public K previous() {
return iterator.previous();
}
/** {@inheritDoc} */
public void remove() {
iterator.remove();
}
/** {@inheritDoc} */
public K getKey() {
return iterator.getKey();
}
/** {@inheritDoc} */
public V getValue() {
return iterator.getValue();
}
/** {@inheritDoc} */
public V setValue(final V obj) {
return iterator.setValue(obj);
}
}