1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.collections4.iterators;
18
19 import org.apache.commons.collections4.OrderedIterator;
20
21 /**
22 * Provides an implementation of an empty ordered iterator.
23 *
24 * @param <E> the type of elements returned by this iterator.
25 * @since 3.1
26 */
27 public class EmptyOrderedIterator<E> extends AbstractEmptyIterator<E>
28 implements OrderedIterator<E> {
29
30 /**
31 * Singleton instance of the iterator.
32 *
33 * @since 3.1
34 */
35 @SuppressWarnings("rawtypes")
36 public static final OrderedIterator INSTANCE = new EmptyOrderedIterator<>();
37
38 /**
39 * Typed instance of the iterator.
40 *
41 * @param <E> the element type
42 * @return OrderedIterator<E>
43 */
44 public static <E> OrderedIterator<E> emptyOrderedIterator() {
45 return INSTANCE;
46 }
47
48 /**
49 * Constructs a new instance.
50 */
51 protected EmptyOrderedIterator() {
52 }
53
54 }