001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  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.apache.wicket.util.visit;
018
019/**
020 * Allows visitors to control the visit/traversal
021 * 
022 * @author igor.vaynberg
023 * 
024 * @param <R>
025 *            type of object the visitor is expected to return, if none use {@link Void}
026 */
027public interface IVisit<R>
028{
029        /**
030         * Stops the visit/traversal
031         */
032        void stop();
033
034        /**
035         * Stops the visit/traversal and returns {@code result}
036         * 
037         * @param result
038         */
039        void stop(R result);
040
041        /**
042         * Prevents the visitor from visiting any children of the object currently visited
043         */
044        void dontGoDeeper();
045}