Package io.objectbox.tree

Class Branch

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private long id  
      private Tree tree  

    • Constructor Summary

      Constructors 
      Constructor Description
      Branch​(Tree tree, long id)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Branch branch​(java.lang.String pathString)
      Get the branch following the given path of child branches from this branch.
      Branch branch​(java.lang.String[] path)
      Get the branch following the given path of child branches from this branch.
      Branch branchChild​(java.lang.String name)
      Get the child branch directly attached to this branch with the given name.
      private void checkNameOrPath​(java.lang.String name)  
      private void checkPath​(java.lang.String[] path)  
      long getId()  
      Tree getTree()  
      Leaf leaf​(java.lang.String pathString)
      Get the leaf following the given path of children from this branch.
      Leaf leaf​(java.lang.String[] path)
      Get the leaf following the given path of children from this branch.
      Leaf leafChild​(java.lang.String name)
      Get the child leaf directly attached to this branch with the given name.
      private long nativeGetBranchId​(long treeHandle, long branchId, java.lang.String[] path)
      Get a data branch ID matching the path, starting at the given data branchId.
      private LeafNode nativeGetLeaf​(long treeHandle, long branchId, java.lang.String[] path)
      Get a data leaf matching the path, starting at the given data branchId.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • tree

        private final Tree tree

      • id

        private final long id

    • Constructor Detail

      • Branch

        Branch​(Tree tree,
       long id)

    • Method Detail

      • getTree

        public Tree getTree()

      • getId

        public long getId()

      • branch

        @Nullable
public Branch branch​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.String name)

      • checkPath

        private void checkPath​(java.lang.String[] path)

      • nativeGetBranchId

        private long nativeGetBranchId​(long treeHandle,
                               long branchId,
                               java.lang.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,
                               java.lang.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.