1/*
2The MIT License
3
4Copyright (c) 2008 Tahseen Ur Rehman, Javid Jamae
5
6http://code.google.com/p/radixtree/
7
8Permission is hereby granted, free of charge, to any person obtaining a copy
9of this software and associated documentation files (the "Software"), to deal
10in the Software without restriction, including without limitation the rights
11to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12copies of the Software, and to permit persons to whom the Software is
13furnished to do so, subject to the following conditions:
14
15The above copyright notice and this permission notice shall be included in
16all copies or substantial portions of the Software.
17
18THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24THE SOFTWARE.
25*/
26
27package ds.tree;
28
29/**
30 * The visitor interface that is used by {@link RadixTreeImpl} for perfroming
31 * task on a searched node.
32 *
33 * @author Tahseen Ur Rehman (tahseen.ur.rehman {at.spam.me.not} gmail.com)
34 * @author Javid Jamae
35 * @author Dennis Heidsiek
36 * @param <T,R>
37 */
38public interface Visitor<T, R> {
39    /**
40     * This method gets called by {@link RadixTreeImpl#visit(String, Visitor) visit}
41     * when it finds a node matching the key given to it.
42     *
43     * @param key The key that matched the node
44     * @param parent The parent of the node being visited
45     * @param node The node that is being visited
46     */
47    public void visit(String key, RadixTreeNode<T> parent, RadixTreeNode<T> node);
48
49    /**
50     * The visitor can store any type of result object, depending on the context of
51     * what it is being used for.
52     *
53     * @return The result captured by the visitor.
54     */
55    public R getResult();
56}
57