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