001/*-------------------------------------------------------------------------+
002|                                                                          |
003| Copyright 2005-2011 The ConQAT Project                                   |
004|                                                                          |
005| Licensed under the Apache License, Version 2.0 (the "License");          |
006| you may not use this file except in compliance with the License.         |
007| You may obtain a copy of the License at                                  |
008|                                                                          |
009|    http://www.apache.org/licenses/LICENSE-2.0                            |
010|                                                                          |
011| Unless required by applicable law or agreed to in writing, software      |
012| distributed under the License is distributed on an "AS IS" BASIS,        |
013| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
014| See the License for the specific language governing permissions and      |
015| limitations under the License.                                           |
016+-------------------------------------------------------------------------*/
017package org.conqat.lib.commons.visitor;
018
019import java.util.Collection;
020
021import org.conqat.lib.commons.error.NeverThrownRuntimeException;
022
023/**
024 * Interface for a mesh walker, i.e. a class which allows the traversal of a
025 * general mesh of elements.
026 * 
027 * @param <T>
028 *            the type of the elements of the mesh.
029 * @param <X>
030 *            the type of exception thrown. Use
031 *            {@link NeverThrownRuntimeException} if no exception is thrown
032 * 
033 * @author hummelb
034 */
035@FunctionalInterface
036public interface IMeshWalker<T, X extends Exception> {
037
038        /**
039         * Returns all elements which are directly reachable from a given element (and
040         * are part of the mesh).
041         */
042        public Collection<T> getAdjacentElements(T element) throws X;
043
044}