You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: bosk-core/src/main/java/works/bosk/Bosk.java
+13-1Lines changed: 13 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -100,7 +100,7 @@ public class Bosk<R extends StateTreeNode> implements BoskInfo<R> {
100
100
privatevolatileRcurrentRoot;
101
101
102
102
/**
103
-
* @param name Any stringthat identifies this object.
103
+
* @param name A distinctive identifier string. The bosk framework doesn't use this, so there are no requirements on this string: it can be anything that identifies the object.
104
104
* @param rootType The @{link Type} of the root node of the state tree, whose {@link Reference#path path} is <code>"/"</code>.
105
105
* @param defaultRootFunction The root object to use if the driver chooses not to supply one,
106
106
* and instead delegates {@link BoskDriver#initialRoot} all the way to the local driver.
@@ -155,6 +155,18 @@ public Bosk(String name, Type rootType, DefaultRootFunction<R> defaultRootFuncti
* Convenience method to create a bosk with only the basic functionality,
160
+
* to get going quickly.
161
+
* To customize the bosk behaviour later,
162
+
* you can inline this into your call site and modify it as desired.
163
+
* @param name A distinctive identifier string. The bosk framework doesn't use this, so there are no requirements on this string: it can be anything that identifies the object.
164
+
* @param initialRoot The starting value of the bosk state tree, before any updates.
0 commit comments