001/*
002 * Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.
008 *
009 * This code is distributed in the hope that it will be useful, but WITHOUT
010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
011 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
012 * version 2 for more details (a copy is included in the LICENSE file that
013 * accompanied this code).
014 *
015 * You should have received a copy of the GNU General Public License version
016 * 2 along with this work; if not, write to the Free Software Foundation,
017 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
018 *
019 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
020 * or visit www.oracle.com if you need additional information or have any
021 * questions.
022 */
023package com.oracle.graal.graph.iterators;
024
025import java.util.*;
026
027import com.oracle.graal.graph.*;
028
029public interface NodeIterable<T extends Node> extends Iterable<T> {
030
031    @SuppressWarnings("unchecked")
032    default <F extends T> NodeIterable<F> filter(Class<F> clazz) {
033        return (NodeIterable<F>) new FilteredNodeIterable<>(this).and(NodePredicates.isA(clazz));
034    }
035
036    default NodeIterable<T> filterInterface(Class<?> iface) {
037        return new FilteredNodeIterable<>(this).and(NodePredicates.isAInterface(iface));
038    }
039
040    default FilteredNodeIterable<T> filter(NodePredicate predicate) {
041        return new FilteredNodeIterable<>(this).and(predicate);
042    }
043
044    default FilteredNodeIterable<T> nonNull() {
045        return new FilteredNodeIterable<>(this).and(NodePredicates.isNotNull());
046    }
047
048    default NodeIterable<T> distinct() {
049        return new FilteredNodeIterable<>(this).distinct();
050    }
051
052    default List<T> snapshot() {
053        ArrayList<T> list = new ArrayList<>();
054        snapshotTo(list);
055        return list;
056    }
057
058    default void snapshotTo(Collection<? super T> to) {
059        for (T n : this) {
060            to.add(n);
061        }
062    }
063
064    default T first() {
065        Iterator<T> iterator = iterator();
066        if (iterator.hasNext()) {
067            return iterator.next();
068        }
069        return null;
070    }
071
072    default int count() {
073        int count = 0;
074        Iterator<T> iterator = iterator();
075        while (iterator.hasNext()) {
076            iterator.next();
077            count++;
078        }
079        return count;
080    }
081
082    default boolean isEmpty() {
083        return !iterator().hasNext();
084    }
085
086    default boolean isNotEmpty() {
087        return iterator().hasNext();
088    }
089
090    default boolean contains(T node) {
091        return this.filter(NodePredicates.equals(node)).isNotEmpty();
092    }
093}