1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.tree

File Tree.java

 

Code metrics

0
0
0
1
50
11
0
-
-
0
-

Classes

Class Line # Actions
Tree 36 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.tree;
21   
22    import java.util.List;
23   
24    import org.xwiki.component.annotation.Role;
25    import org.xwiki.stability.Unstable;
26   
27    /**
28    * The interface used to represent a tree structure.
29    *
30    * @version $Id: d1595a9aec8c2e6d2fa574b85413276719d03321 $
31    * @since 8.3M2
32    * @since 7.4.5
33    */
34    @Role
35    @Unstable
 
36    public interface Tree extends TreeNode
37    {
38    /**
39    * The property that specifies the id of the root node. This is used to represent a sub-tree.
40    */
41    String PROPERTY_ROOT = "root";
42   
43    /**
44    * Retrieve the path of the specified node.
45    *
46    * @param nodeId the node id
47    * @return the path of the specified node
48    */
49    List<String> getPath(String nodeId);
50    }