Skip to content

Commit 69871ea

Browse files
committed
Tree: extend JavaDocs
1 parent b1fffe7 commit 69871ea

File tree

1 file changed

+9
-0
lines changed
  • objectbox-java/src/main/java/io/objectbox/tree

1 file changed

+9
-0
lines changed

objectbox-java/src/main/java/io/objectbox/tree/Tree.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,17 @@
1111
import java.util.concurrent.Callable;
1212

1313
/**
14+
* A higher level tree API operating on branch and leaf nodes.
1415
* Points to a root branch, can traverse child branches and read and write data in leafs.
1516
* <p>
17+
* Depends on a compatible tree model (entity types), which is matched by type and property names.
18+
* E.g. names like "DataLeaf.valueString" are fixed and may not be changed.
19+
* Adding properties to tree types is allowed.
20+
* <p>
21+
* Note there are TWO ways to work with tree data (both ways can be mixed):
22+
* - Standard ObjectBox entity types with e.g. Box<DataLeaf>
23+
* - Higher level tree API via this Tree class
24+
* <p>
1625
* To navigate in the tree, you typically start with {@link #getRoot()}, which returns a {@link Branch}.
1726
* From one branch you can navigate to other branches and also {@link Leaf}s, which carry data attributes.
1827
* <p>

0 commit comments

Comments
 (0)