rename InstanceOptions to Options

fahad19 · fahad19 · commit 19f3286bf269 · 2025-08-05T16:39:13.000+02:00
diff --git a/README.md b/README.md
@@ -118,6 +118,7 @@ The SDK can be initialized by passing [datafile](https://featurevisor.com/docs/b
 
 ```java
 import com.featurevisor.sdk.Featurevisor;
+import com.featurevisor.sdk.ChildInstance;
 import com.featurevisor.types.DatafileContent;
 
 // Load datafile content
@@ -128,8 +129,8 @@ String datafileContent = "..." // ... load your datafile content
 DatafileContent datafile = DatafileContent.fromJson(datafileContent);
 
 // Create SDK instance
-Featurevisor f = new Featurevisor(
-    new Featurevisor.InstanceOptions()
+Featurevisor f = Featurevisor.createInstance(
+    new Featurevisor.Options()
         .datafile(datafileContent)
 );
 ```
@@ -170,7 +171,7 @@ Map<String, Object> initialContext = new HashMap<>();
 initialContext.put("deviceId", "123");
 initialContext.put("country", "nl");
 
-Featurevisor f = new Featurevisor(new Featurevisor.InstanceOptions()
+Featurevisor f = Featurevisor.createInstance(new Featurevisor.Options()
     .datafile(datafile)
     .context(initialContext));
 ```
@@ -357,7 +358,7 @@ Map<String, Object> anotherFeatureSticky = new HashMap<>();
 anotherFeatureSticky.put("enabled", false);
 stickyFeatures.put("anotherFeatureKey", anotherFeatureSticky);
 
-Featurevisor f = new Featurevisor(new Featurevisor.InstanceOptions()
+Featurevisor f = Featurevisor.createInstance(new Featurevisor.Options()
     .datafile(datafile)
     .sticky(stickyFeatures));
 ```
@@ -433,7 +434,7 @@ Setting `debug` level will print out all logs, including `info`, `warn`, and `er
 ```java
 import com.featurevisor.sdk.Logger;
 
-Featurevisor f = new Featurevisor(new Featurevisor.InstanceOptions()
+Featurevisor f = Featurevisor.createInstance(new Featurevisor.Options()
     .datafile(datafile)
     .logLevel(Logger.LogLevel.DEBUG));
 ```
@@ -457,7 +458,7 @@ Logger customLogger = Logger.createLogger(new Logger.CreateLoggerOptions()
         System.out.println("[" + level + "] " + message);
     }));
 
-Featurevisor f = new Featurevisor(new Featurevisor.InstanceOptions()
+Featurevisor f = Featurevisor.createInstance(new Featurevisor.Options()
     .datafile(datafile)
     .logger(customLogger));
 ```
@@ -470,7 +471,7 @@ Logger customLogger = new Logger(Logger.LogLevel.INFO, (level, message, details)
     System.out.println("[" + level + "] " + message);
 });
 
-Featurevisor f = new Featurevisor(new Featurevisor.InstanceOptions()
+Featurevisor f = Featurevisor.createInstance(new Featurevisor.Options()
     .datafile(datafile)
     .logger(customLogger));
 ```
@@ -637,7 +638,7 @@ You can register hooks at the time of SDK initialization:
 List<Map<String, Object>> hooks = new ArrayList<>();
 hooks.add(myCustomHook);
 
-Featurevisor f = new Featurevisor(new Featurevisor.InstanceOptions()
+Featurevisor f = Featurevisor.createInstance(new Featurevisor.Options()
     .datafile(datafile)
     .hooks(hooks));
 ```
@@ -662,7 +663,7 @@ That's where child instances come in handy:
 Map<String, Object> childContext = new HashMap<>();
 childContext.put("userId", "123");
 
-Featurevisor childF = f.spawn(childContext);
+ChildInstance childF = f.spawn(childContext);
 ```
 
 Now you can pass the child instance where your individual request is being handled, and you can continue to evaluate features targeting that specific user alone:
diff --git a/src/main/java/com/featurevisor/cli/CLI.java b/src/main/java/com/featurevisor/cli/CLI.java
@@ -580,7 +580,7 @@ private void test() {
         Map<String, Featurevisor> sdkInstancesByEnvironment = new HashMap<>();
             for (String environment : environments) {
                 DatafileContent datafile = datafilesByEnvironment.get(environment);
-                Featurevisor instance = Featurevisor.createInstance(new Featurevisor.InstanceOptions()
+                Featurevisor instance = Featurevisor.createInstance(new Featurevisor.Options()
                     .datafile(datafile)
                     .logLevel(level));
                 sdkInstancesByEnvironment.put(environment, instance);
@@ -630,7 +630,7 @@ private void test() {
                             hooksManager.add(new HooksManager.Hook("at-parameter")
                                 .bucketValue((options) -> (int) (atValue * 1000)));
 
-                            f = Featurevisor.createInstance(new Featurevisor.InstanceOptions()
+                            f = Featurevisor.createInstance(new Featurevisor.Options()
                                 .datafile(datafile)
                                 .logLevel(level)
                                 .hooks(hooksManager.getAll()));
@@ -709,7 +709,7 @@ private void benchmark() {
             Logger.LogLevel level = getLoggerLevel();
             Map<String, DatafileContent> datafilesByEnvironment = buildDatafiles(rootDirectoryPath, Arrays.asList(environment));
 
-            Featurevisor f = Featurevisor.createInstance(new Featurevisor.InstanceOptions()
+            Featurevisor f = Featurevisor.createInstance(new Featurevisor.Options()
                 .datafile(datafilesByEnvironment.get(environment))
                 .logLevel(level));
 
@@ -772,7 +772,7 @@ private void assessDistribution() {
 
             Map<String, DatafileContent> datafilesByEnvironment = buildDatafiles(rootDirectoryPath, Arrays.asList(environment));
 
-            Featurevisor f = Featurevisor.createInstance(new Featurevisor.InstanceOptions()
+            Featurevisor f = Featurevisor.createInstance(new Featurevisor.Options()
                 .datafile(datafilesByEnvironment.get(environment))
                 .logLevel(getLoggerLevel()));
 
diff --git a/src/main/java/com/featurevisor/sdk/Featurevisor.java b/src/main/java/com/featurevisor/sdk/Featurevisor.java
@@ -35,10 +35,52 @@ public class Featurevisor {
         emptyDatafile.setFeatures(new HashMap<>());
     }
 
+    /**
+     * Factory methods
+     */
+    public static Featurevisor createInstance(Options options) {
+        if (options == null) {
+            options = new Options();
+        }
+        return new Featurevisor(options);
+    }
+
+    public static Featurevisor createInstance() {
+        return createInstance(new Options());
+    }
+
+    public static Featurevisor createInstance(com.featurevisor.types.DatafileContent datafile) {
+        return createInstance(new Options().datafile(datafile));
+    }
+
+    public static Featurevisor createInstance(String datafileString) {
+        return createInstance(new Options().datafileString(datafileString));
+    }
+
+    public static Featurevisor createInstance(Map<String, Object> context) {
+        return createInstance(new Options().context(context));
+    }
+
+    public static Featurevisor createInstance(Logger.LogLevel logLevel) {
+        return createInstance(new Options().logLevel(logLevel));
+    }
+
+    public static Featurevisor createInstance(Logger logger) {
+        return createInstance(new Options().logger(logger));
+    }
+
+    public static Featurevisor createInstance(Map<String, Object> sticky, boolean isSticky) {
+        if (isSticky) {
+            return createInstance(new Options().sticky(sticky));
+        } else {
+            return createInstance(new Options().context(sticky));
+        }
+    }
+
     /**
      * Options for creating an instance
      */
-    public static class InstanceOptions {
+    public static class Options {
         private DatafileContent datafile;
         private String datafileString;
         private Map<String, Object> context;
@@ -47,7 +89,7 @@ public static class InstanceOptions {
         private Map<String, Object> sticky;
         private List<HooksManager.Hook> hooks;
 
-        public InstanceOptions() {}
+        public Options() {}
 
         // Getters
         public DatafileContent getDatafile() { return datafile; }
@@ -68,37 +110,37 @@ public InstanceOptions() {}
         public void setHooks(List<HooksManager.Hook> hooks) { this.hooks = hooks; }
 
         // Builder pattern methods
-        public InstanceOptions datafile(DatafileContent datafile) {
+        public Options datafile(DatafileContent datafile) {
             this.datafile = datafile;
             return this;
         }
 
-        public InstanceOptions datafileString(String datafileString) {
+        public Options datafileString(String datafileString) {
             this.datafileString = datafileString;
             return this;
         }
 
-        public InstanceOptions context(Map<String, Object> context) {
+        public Options context(Map<String, Object> context) {
             this.context = context;
             return this;
         }
 
-        public InstanceOptions logLevel(Logger.LogLevel logLevel) {
+        public Options logLevel(Logger.LogLevel logLevel) {
             this.logLevel = logLevel;
             return this;
         }
 
-        public InstanceOptions logger(Logger logger) {
+        public Options logger(Logger logger) {
             this.logger = logger;
             return this;
         }
 
-        public InstanceOptions sticky(Map<String, Object> sticky) {
+        public Options sticky(Map<String, Object> sticky) {
             this.sticky = sticky;
             return this;
         }
 
-        public InstanceOptions hooks(List<HooksManager.Hook> hooks) {
+        public Options hooks(List<HooksManager.Hook> hooks) {
             this.hooks = hooks;
             return this;
         }
@@ -152,7 +194,7 @@ public OverrideOptions flagEvaluation(Evaluation flagEvaluation) {
     /**
      * Constructor
      */
-    public Featurevisor(InstanceOptions options) {
+    public Featurevisor(Options options) {
         // from options
         if (options.getContext() != null) {
             this.context = new HashMap<>(options.getContext());
@@ -194,48 +236,6 @@ public Featurevisor(InstanceOptions options) {
         this.logger.info("Featurevisor SDK initialized", null);
     }
 
-    /**
-     * Factory methods
-     */
-    public static Featurevisor createInstance(InstanceOptions options) {
-        if (options == null) {
-            options = new InstanceOptions();
-        }
-        return new Featurevisor(options);
-    }
-
-    public static Featurevisor createInstance() {
-        return createInstance(new InstanceOptions());
-    }
-
-    public static Featurevisor createInstance(com.featurevisor.types.DatafileContent datafile) {
-        return createInstance(new InstanceOptions().datafile(datafile));
-    }
-
-    public static Featurevisor createInstance(String datafileString) {
-        return createInstance(new InstanceOptions().datafileString(datafileString));
-    }
-
-    public static Featurevisor createInstance(Map<String, Object> context) {
-        return createInstance(new InstanceOptions().context(context));
-    }
-
-    public static Featurevisor createInstance(Logger.LogLevel logLevel) {
-        return createInstance(new InstanceOptions().logLevel(logLevel));
-    }
-
-    public static Featurevisor createInstance(Logger logger) {
-        return createInstance(new InstanceOptions().logger(logger));
-    }
-
-    public static Featurevisor createInstance(Map<String, Object> sticky, boolean isSticky) {
-        if (isSticky) {
-            return createInstance(new InstanceOptions().sticky(sticky));
-        } else {
-            return createInstance(new InstanceOptions().context(sticky));
-        }
-    }
-
     /**
      * Set log level
      */
diff --git a/src/test/java/com/featurevisor/sdk/ChildTest.java b/src/test/java/com/featurevisor/sdk/ChildTest.java
@@ -249,7 +249,7 @@ public void testCreateChildInstance() {
         Map<String, Object> parentContext = new HashMap<>();
         parentContext.put("appVersion", "1.0.0");
 
-        Featurevisor parentInstance = new Featurevisor(new Featurevisor.InstanceOptions()
+        Featurevisor parentInstance = new Featurevisor(new Featurevisor.Options()
             .datafile(datafile)
             .context(parentContext));
 
diff --git a/src/test/java/com/featurevisor/sdk/InstanceTest.java b/src/test/java/com/featurevisor/sdk/InstanceTest.java
