Use enable_headless_mode() function as appropriate

ctrueden · ctrueden · commit 5be0963be5ff · 2023-12-06T11:41:16.000-06:00
diff --git a/README.md b/README.md
@@ -55,7 +55,7 @@ u'1.8.0_152-release'
 
 ```python
 >>> from scyjava import config, jimport
->>> config.add_option('-Djava.awt.headless=true')
+>>> config.enable_headless_mode()
 >>> config.add_repositories({'scijava.public': 'https://maven.scijava.org/content/groups/public'})
 >>> config.endpoints.append('net.imagej:imagej:2.1.0')
 >>> ImageJ = jimport('net.imagej.ImageJ')
@@ -408,7 +408,7 @@ FUNCTIONS
         fly with the configuration specified via the scijava.config mechanism.
 
         :param options: List of options to pass to the JVM. For example:
-                        ['-Djava.awt.headless=true', '-Xmx4g']
+                        ['-Dfoo=bar', '-XX:+UnlockExperimentalVMOptions']
 
     to_java(obj: Any, **hints: Dict) -> Any
         Recursively convert a Python object to a Java object.
@@ -506,7 +506,7 @@ unless you do one of two things:
 
     ```python
     from scyjava import config, jimport
-    config.add_option('-Djava.awt.headless=true')
+    config.enable_headless_mode()
     ```
 
     In which case, you'll get `java.awt.HeadlessException` instead of a
diff --git a/src/scyjava/__init__.py b/src/scyjava/__init__.py
@@ -11,7 +11,7 @@
 Use Maven artifacts from remote repositories:
 
     >>> from scyjava import config, jimport
-    >>> config.add_option('-Djava.awt.headless=true')
+    >>> config.enable_headless_mode()
     >>> config.add_repositories({
     ... 'scijava.public': 'https://maven.scijava.org/content/groups/public',
     ... })
diff --git a/src/scyjava/_java.py b/src/scyjava/_java.py
@@ -167,7 +167,7 @@ def start_jvm(options=None) -> None:
     fly with the configuration specified via the scijava.config mechanism.
 
     :param options: List of options to pass to the JVM. For example:
-                    ['-Djava.awt.headless=true', '-Xmx4g']
+                    ['-Dfoo=bar', '-XX:+UnlockExperimentalVMOptions']
     """
     # if JVM is already running -- break
     if jvm_started():
diff --git a/tests/it/jvm_version.py b/tests/it/jvm_version.py
@@ -11,7 +11,7 @@
 assert len(before_version) >= 3
 assert before_version[0] > 0
 
-scyjava.config.add_option("-Djava.awt.headless=true")
+scyjava.config.enable_headless_mode()
 scyjava.start_jvm()
 
 after_version = scyjava.jvm_version()
diff --git a/tests/test_convert.py b/tests/test_convert.py
@@ -21,7 +21,7 @@
 from scyjava.config import Mode, mode
 
 config.endpoints.append("org.scijava:scijava-table")
-config.add_option("-Djava.awt.headless=true")
+config.enable_headless_mode()
 
 
 class TestConvert(object):
diff --git a/tests/test_pandas.py b/tests/test_pandas.py
@@ -5,7 +5,7 @@
 from scyjava import config, jarray, jimport, jinstance, to_java, to_python
 
 config.endpoints.append("org.scijava:scijava-table")
-config.add_option("-Djava.awt.headless=true")
+config.enable_headless_mode()
 
 
 def assert_same_table(table, df):
