org.apache.cayenne.project.ProjectTraversalHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cayenne-client-nodeps

Cayenne Object Persistence Framework

There is a newer version: 2.0.4

/*****************************************************************
 *   Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 ****************************************************************/

package org.apache.cayenne.project;

/**
 * ProjectTraversalHandler defines callback methods that are
 * invoked during project tree traversal.
 * 
 * @author Andrei Adamchik
 */
public interface ProjectTraversalHandler {
    /** 
     * Invoked when a node is read during project tree traversal.
     */
    public void projectNode(ProjectPath nodePath);

    /**
     * Invoked when the children of a project node are
     * about to be scanned. If handler returns false, children
     * of the node (and trheir children) will be skipped. This
     * allows handler to control traversal behavior by eliminating 
     * subtrees.
     */
    public boolean shouldReadChildren(Object node, ProjectPath parentPath);
}