indexer-core/src/main/java/org/apache/maven/index/treeview/IndexTreeView.java

package org.apache.maven.index.treeview;

/*
 * 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.
 */

import java.io.IOException;

/**
 * Component rendering a "tree" based on index data.
 * 
 * @author cstamas
 */
public interface IndexTreeView
{
    /**
     * Returns the TreeNode, as calculated by passed in request, using index data.
     * 
     * @param request
     * @return
     * @throws IOException
     */
    TreeNode listNodes( TreeViewRequest request )
        throws IOException;
}