2 * Copyright (c) 2012 Big Switch Networks, Inc.
4 * Licensed under the Eclipse Public License, Version 1.0 (the
5 * "License"); you may not use this file except in compliance with the
6 * License. You may obtain a copy of the License at
8 * http://www.eclipse.org/legal/epl-v10.html
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
13 * implied. See the License for the specific language governing
14 * permissions and limitations under the License.
16 * This file incorporates work covered by the following copyright and
19 * Originally created by David Erickson, Stanford University
21 * Licensed under the Apache License, Version 2.0 (the "License");
22 * you may not use this file except in compliance with the
23 * License. You may obtain a copy of the License at
25 * http://www.apache.org/licenses/LICENSE-2.0
27 * Unless required by applicable law or agreed to in writing,
28 * software distributed under the License is distributed on an "AS
29 * IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
30 * express or implied. See the License for the specific language
31 * governing permissions and limitations under the License.
34 package org.opendaylight.controller.sal.utils;
36 import java.util.Iterator;
37 import java.util.NoSuchElementException;
40 * An iterator that will filter values from an iterator and return only those
41 * values that match the predicate.
44 public abstract class FilterIterator<T> implements Iterator<T> {
45 protected Iterator<T> subIterator;
49 * Construct a filter iterator from the given sub iterator
52 * the sub iterator over which we'll filter
54 public FilterIterator(Iterator<T> subIterator) {
56 this.subIterator = subIterator;
60 * Check whether the given value should be returned by the filter
64 * @return true if the value should be included
66 protected abstract boolean matches(T value);
73 public boolean hasNext() {
77 while (subIterator.hasNext()) {
78 next = subIterator.next();
93 throw new NoSuchElementException();
97 public void remove() {
98 throw new UnsupportedOperationException();