001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements. See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership. The ASF licenses this file
006     * to you 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    /*
019     * $Id: XPathVisitable.java 468655 2006-10-28 07:12:06Z minchau $
020     */
021    package org.apache.xpath;
022    
023    /**
024     * A class that implements this interface will call a XPathVisitor 
025     * for itself and members within it's heararchy.  If the XPathVisitor's 
026     * method returns false, the sub-member heararchy will not be 
027     * traversed.
028     */
029    public interface XPathVisitable
030    {
031            /**
032             * This will traverse the heararchy, calling the visitor for 
033             * each member.  If the called visitor method returns 
034             * false, the subtree should not be called.
035             * 
036             * @param owner The owner of the visitor, where that path may be 
037             *              rewritten if needed.
038             * @param visitor The visitor whose appropriate method will be called.
039             */
040            public void callVisitors(ExpressionOwner owner, XPathVisitor visitor);
041    }
042