1 /*
2 * Copyright 2016 Function1. All Rights Reserved.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package tools.gsf.navigation;
17
18 import java.io.Serializable;
19 import java.util.List;
20
21 /**
22 * Navigation structure node. Knows how to return parent nodes, child nodes and sibling nodes.
23 *
24 * Designed to be extended to support more sophisticated node types.
25 *
26 * @author Tony Field
27 * @since 2016-07-02.
28 */
29 public interface Node<N extends Node<N>> extends Serializable {
30
31 /**
32 * Get the parent node
33 * @return parent node
34 */
35 N getParent();
36
37 /**
38 * Get the siblings of this node. All siblings are returned in ranked order, including this node.
39 * @return sibling nodes
40 */
41 List<N> getSiblings();
42
43 /**
44 * Return this node's children, if any, in ranked order
45 * @return this node's children, never null.
46 */
47 List<N> getChildren();
48
49 }