Package io.objectbox.tree

Class Branch

java.lang.Object
io.objectbox.tree.Branch
@Experimental public class Branch extends Object
A branch within a Tree. May have branches or leaves.

  • Field Details

    • tree

      private final Tree tree

    • id

      private final long id

  • Constructor Details

    • Branch

      Branch(Tree tree, long id)

  • Method Details

    • getTree

      public Tree getTree()

    • getId

      public long getId()

    • branch

      @Nullable public Branch branch(String[] path)
      Get the branch following the given path of child branches from this branch.
      Returns:
      null if no matching tree node was found

    • branch

      @Nullable public Branch branch(String pathString)
      Get the branch following the given path of child branches from this branch.
      Returns:
      null if no matching tree node was found

    • branchChild

      @Nullable public Branch branchChild(String name)
      Get the child branch directly attached to this branch with the given name.
      Returns:
      null if no matching tree node was found

    • leaf

      @Nullable public Leaf leaf(String[] path)
      Get the leaf following the given path of children from this branch.
      Returns:
      null if no matching tree node was found

    • leaf

      @Nullable public Leaf leaf(String pathString)
      Get the leaf following the given path of children from this branch.
      Returns:
      null if no matching tree node was found

    • leafChild

      @Nullable public Leaf leafChild(String name)
      Get the child leaf directly attached to this branch with the given name.
      Returns:
      null if no matching tree node was found

    • checkNameOrPath

      private void checkNameOrPath(String name)

    • checkPath

      private void checkPath(String[] path)

    • nativeGetBranchId

      private long nativeGetBranchId(long treeHandle, long branchId, String[] path)
      Get a data branch ID matching the path, starting at the given data branchId. If branchId == 0, it assumes there's only one data tree in the database.

    • nativeGetLeaf

      private LeafNode nativeGetLeaf(long treeHandle, long branchId, String[] path)
      Get a data leaf matching the path, starting at the given data branchId. If branchId == 0, it assumes there's only one data tree in the database.