org.apache.commons.collections4.iterators.EmptyListIterator Maven / Gradle / Ivy
Show all versions of commons-collections4 Show documentation
/*
* 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 org.apache.commons.collections4.ResettableListIterator;
/**
* Provides an implementation of an empty list iterator.
*
* This class provides an implementation of an empty list iterator. This class
* provides for binary compatibility between Commons Collections 2.1.1 and 3.1
* due to issues with IteratorUtils
.
*
* @since 2.1.1 and 3.1
*/
public class EmptyListIterator extends AbstractEmptyIterator implements
ResettableListIterator {
/**
* Singleton instance of the iterator.
* @since 3.1
*/
@SuppressWarnings("rawtypes")
public static final ResettableListIterator RESETTABLE_INSTANCE = new EmptyListIterator<>();
/**
* Singleton instance of the iterator.
* @since 2.1.1 and 3.1
*/
@SuppressWarnings("rawtypes")
public static final ListIterator INSTANCE = RESETTABLE_INSTANCE;
/**
* Get a typed instance of the iterator.
* @param the element type
* @return {@link ResettableListIterator}<E>
*/
public static ResettableListIterator resettableEmptyListIterator() {
return RESETTABLE_INSTANCE;
}
/**
* Get a typed instance of the iterator.
* @param the element type
* @return {@link ListIterator}<E>
*/
public static ListIterator emptyListIterator() {
return INSTANCE;
}
/**
* Constructor.
*/
protected EmptyListIterator() {
super();
}
}