1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.tree

File TreeNode.java

 

Code metrics

0
0
0
1
80
14
0
-
-
0
-

Classes

Class Line # Actions
TreeNode 35 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    import java.util.Map;
24   
25    import org.xwiki.component.annotation.Role;
26   
27    /**
28    * The interface used to represent a node in a tree structure.
29    *
30    * @version $Id: 740b15e0005def441dbd4068114e5bb35f6a4e66 $
31    * @since 8.3M2
32    * @since 7.4.5
33    */
34    @Role
 
35    public interface TreeNode
36    {
37    /**
38    * The property that specifies how the child nodes are sorted.
39    */
40    String PROPERTY_ORDER_BY = "orderBy";
41   
42    /**
43    * The property that specifies the nodes to exclude.
44    */
45    String PROPERTY_EXCLUSIONS = "exclusions";
46   
47    /**
48    * Retrieve the children of the specified node.
49    *
50    * @param nodeId the node id
51    * @param offset the offset within the list of child nodes
52    * @param limit the number of child nodes to return
53    * @return a part of the child nodes of the specified node
54    */
55    List<String> getChildren(String nodeId, int offset, int limit);
56   
57    /**
58    * Retrieve the number of children of the specified node.
59    *
60    * @param nodeId the node id
61    * @return the number of child nodes
62    */
63    int getChildCount(String nodeId);
64   
65    /**
66    * Retrieve the parent of the specified node.
67    *
68    * @param nodeId the node id
69    * @return the parent node id
70    */
71    String getParent(String nodeId);
72   
73    /**
74    * Retrieve the properties that can be used to configure the tree node. For instance you may want to sort or filter
75    * the child nodes.
76    *
77    * @return the map of tree node properties
78    */
79    Map<String, Object> getProperties();
80    }