View Javadoc

1   package org.apache.maven.index.treeview;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0    
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.IOException;
23  
24  /**
25   * Component rendering a "tree" based on index data.
26   * 
27   * @author cstamas
28   */
29  public interface IndexTreeView
30  {
31      /**
32       * Returns the TreeNode, as calculated by passed in request, using index data.
33       * 
34       * @param request
35       * @return
36       * @throws IOException
37       */
38      TreeNode listNodes( TreeViewRequest request )
39          throws IOException;
40  }