Use API extensions instead of Java builders for Kotlin snippets (#156)

yevhenii-nadtochii · web-flow · commit e671fac18ebc · 2024-10-04T17:16:52.000+02:00
* Use API extensions instead of builders

* Bump JxBrowser → `8.0.0-eap.6`
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -31,7 +31,7 @@ plugins {
     id("org.jetbrains.kotlin.plugin.compose") version "2.0.0"
 }
 
-val jxBrowserVersion by extra { "8.0.0-eap.5" } // The version of JxBrowser used in the examples.
+val jxBrowserVersion by extra { "8.0.0-eap.6" } // The version of JxBrowser used in the examples.
 val guavaVersion by extra { "29.0-jre" } // Some of the examples use Guava.
 
 allprojects {
diff --git a/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/CustomProtocol.kt b/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/CustomProtocol.kt
@@ -24,10 +24,11 @@ import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.ui.window.singleWindowApplication
 import com.teamdev.jxbrowser.dsl.Engine
 import com.teamdev.jxbrowser.dsl.browser.navigation
+import com.teamdev.jxbrowser.dsl.net.HttpHeader
+import com.teamdev.jxbrowser.dsl.net.Scheme
 import com.teamdev.jxbrowser.dsl.net.UrlRequestJobOptions
 import com.teamdev.jxbrowser.engine.RenderingMode
 import com.teamdev.jxbrowser.net.HttpStatus
-import com.teamdev.jxbrowser.net.Scheme
 import com.teamdev.jxbrowser.net.callback.InterceptUrlRequestCallback
 import com.teamdev.jxbrowser.net.callback.InterceptUrlRequestCallback.Params
 import com.teamdev.jxbrowser.net.callback.InterceptUrlRequestCallback.Response
@@ -56,15 +57,16 @@ fun main() {
 /**
  * URL protocol for custom handling.
  */
-private val PROTOCOL = Scheme.of("jxb")
+private val PROTOCOL = Scheme("jxb")
 
 /**
  * An interceptor, which always sends "Hello there!" text in a response.
  */
 private class RespondWithGreetings : InterceptUrlRequestCallback {
 
     override fun on(params: Params): Response {
-        val options = UrlRequestJobOptions(HttpStatus.OK, "text/html")
+        val contentType = HttpHeader("Content-Type", "text/html")
+        val options = UrlRequestJobOptions(HttpStatus.OK, listOf(contentType))
         val job = params.newUrlRequestJob(options).apply {
             write("<html><body><p>Hello there!</p></body></html>".toByteArray())
             complete()
diff --git a/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/DispatchKeyEvents.kt b/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/DispatchKeyEvents.kt
@@ -28,12 +28,12 @@ import com.teamdev.jxbrowser.dsl.Engine
 import com.teamdev.jxbrowser.dsl.browser.mainFrame
 import com.teamdev.jxbrowser.dsl.browser.navigation
 import com.teamdev.jxbrowser.dsl.subscribe
+import com.teamdev.jxbrowser.dsl.ui.event.KeyPressed
+import com.teamdev.jxbrowser.dsl.ui.event.KeyReleased
+import com.teamdev.jxbrowser.dsl.ui.event.KeyTyped
 import com.teamdev.jxbrowser.engine.RenderingMode
 import com.teamdev.jxbrowser.navigation.event.FrameLoadFinished
 import com.teamdev.jxbrowser.ui.KeyCode
-import com.teamdev.jxbrowser.ui.event.KeyPressed
-import com.teamdev.jxbrowser.ui.event.KeyReleased
-import com.teamdev.jxbrowser.ui.event.KeyTyped
 import com.teamdev.jxbrowser.view.compose.BrowserView
 import java.util.concurrent.CountDownLatch
 
@@ -66,20 +66,9 @@ private fun Browser.loadHtmlAndWait(html: String) {
 
 private fun Browser.dispatchKeyEvent(character: Char) {
     val keyCode = KEY_CODES[character]!!
-    dispatch(
-        KeyPressed.newBuilder(keyCode)
-            .keyChar(character)
-            .build()
-    )
-    dispatch(
-        KeyTyped.newBuilder(keyCode)
-            .keyChar(character)
-            .build()
-    )
-    dispatch(
-        KeyReleased.newBuilder(keyCode)
-            .build()
-    )
+    dispatch(KeyPressed(keyCode, char = character))
+    dispatch(KeyTyped(keyCode, char = character))
+    dispatch(KeyReleased(keyCode))
 }
 
 private val KEY_CODES = mapOf(
diff --git a/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/DispatchMouseEvents.kt b/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/DispatchMouseEvents.kt
@@ -31,10 +31,12 @@ import com.teamdev.jxbrowser.dsl.Engine
 import com.teamdev.jxbrowser.dsl.browser.mainFrame
 import com.teamdev.jxbrowser.dsl.browser.navigation
 import com.teamdev.jxbrowser.dsl.subscribe
+import com.teamdev.jxbrowser.dsl.ui.Point
+import com.teamdev.jxbrowser.dsl.ui.event.MousePressed
+import com.teamdev.jxbrowser.dsl.ui.event.MouseReleased
 import com.teamdev.jxbrowser.engine.RenderingMode
 import com.teamdev.jxbrowser.navigation.event.FrameLoadFinished
 import com.teamdev.jxbrowser.ui.MouseButton
-import com.teamdev.jxbrowser.ui.Point
 import com.teamdev.jxbrowser.ui.event.MousePressed
 import com.teamdev.jxbrowser.ui.event.MouseReleased
 import com.teamdev.jxbrowser.view.compose.BrowserView
@@ -67,14 +69,18 @@ fun main() {
  */
 private fun Browser.dispatchMouseEvent() {
     dispatch(
-        MousePressed.newBuilder(Point.of(50, 50))
-            .button(MouseButton.SECONDARY).clickCount(1)
-            .build()
+        MousePressed(
+            location = Point(50, 50),
+            button = MouseButton.SECONDARY,
+            clickCount = 1
+        )
     )
     dispatch(
-        MouseReleased.newBuilder(Point.of(50, 50))
-            .button(MouseButton.SECONDARY).clickCount(1)
-            .build()
+        MouseReleased(
+            location = Point(50, 50),
+            button = MouseButton.SECONDARY,
+            clickCount = 1
+        )
     )
 }
 
diff --git a/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/InterceptRequest.kt b/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/InterceptRequest.kt
@@ -24,6 +24,7 @@ import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.ui.window.singleWindowApplication
 import com.teamdev.jxbrowser.dsl.Engine
 import com.teamdev.jxbrowser.dsl.browser.navigation
+import com.teamdev.jxbrowser.dsl.net.HttpHeader
 import com.teamdev.jxbrowser.dsl.net.UrlRequestJobOptions
 import com.teamdev.jxbrowser.engine.RenderingMode
 import com.teamdev.jxbrowser.net.HttpStatus
@@ -59,11 +60,10 @@ fun main() {
 private class RespondWithSalutation : InterceptUrlRequestCallback {
 
     override fun on(params: Params): Response {
-        val headers = setOf(
-            "Content-Type" to "text/html",
-            "Content-Type" to "charset=utf-8"
+        val headers = listOf(
+            HttpHeader("Content-Type", "text/html"),
+            HttpHeader("Content-Type", "charset=utf-8")
         )
-
         val options = UrlRequestJobOptions(HttpStatus.OK, headers)
         val job = params.newUrlRequestJob(options)
 
diff --git a/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/JarProtocol.kt b/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/JarProtocol.kt
@@ -23,6 +23,7 @@ package com.teamdev.jxbrowser.examples
 import androidx.compose.ui.window.singleWindowApplication
 import com.teamdev.jxbrowser.dsl.Engine
 import com.teamdev.jxbrowser.dsl.browser.navigation
+import com.teamdev.jxbrowser.dsl.net.HttpHeader
 import com.teamdev.jxbrowser.dsl.net.UrlRequestJobOptions
 import com.teamdev.jxbrowser.engine.RenderingMode
 import com.teamdev.jxbrowser.net.HttpStatus
@@ -98,7 +99,8 @@ private class InterceptJarRequestCallback : InterceptUrlRequestCallback {
         entry: JarEntry,
         params: Params
     ): UrlRequestJob {
-        val options = UrlRequestJobOptions(HttpStatus.OK, entry.mimeType)
+        val contentType = HttpHeader("Content-Type", entry.mimeType)
+        val options = UrlRequestJobOptions(HttpStatus.OK, listOf(contentType))
         val job = params.newUrlRequestJob(options).apply {
             write(entry.data)
             complete()
diff --git a/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/LoadHtmlThroughInterceptRequest.kt b/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/LoadHtmlThroughInterceptRequest.kt
@@ -23,6 +23,7 @@ package com.teamdev.jxbrowser.examples
 import androidx.compose.ui.window.singleWindowApplication
 import com.teamdev.jxbrowser.dsl.Engine
 import com.teamdev.jxbrowser.dsl.browser.navigation
+import com.teamdev.jxbrowser.dsl.net.HttpHeader
 import com.teamdev.jxbrowser.dsl.net.UrlRequestJobOptions
 import com.teamdev.jxbrowser.engine.RenderingMode
 import com.teamdev.jxbrowser.net.HttpStatus
@@ -42,7 +43,8 @@ fun main() {
             proceed()
         }
         val bytes = "<html><body>Hello!</body></html>".toByteArray()
-        val options = UrlRequestJobOptions(HttpStatus.OK, "text/html")
+        val contentType = HttpHeader("Content-Type", "text/html")
+        val options = UrlRequestJobOptions(HttpStatus.OK, listOf(contentType))
         val job = params.newUrlRequestJob(options).apply {
             write(bytes)
             complete()
diff --git a/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/UploadData.kt b/examples/src/main/kotlin/com/teamdev/jxbrowser/examples/UploadData.kt
@@ -22,12 +22,13 @@ package com.teamdev.jxbrowser.examples
 
 import com.teamdev.jxbrowser.dsl.Engine
 import com.teamdev.jxbrowser.dsl.browser.navigation
+import com.teamdev.jxbrowser.dsl.navigation.LoadUrlParams
 import com.teamdev.jxbrowser.dsl.net.FormData
+import com.teamdev.jxbrowser.dsl.net.StringEntry
 import com.teamdev.jxbrowser.dsl.net.TextData
 import com.teamdev.jxbrowser.dsl.network
 import com.teamdev.jxbrowser.dsl.register
 import com.teamdev.jxbrowser.engine.RenderingMode
-import com.teamdev.jxbrowser.navigation.LoadUrlParams
 import com.teamdev.jxbrowser.net.callback.BeforeSendUploadDataCallback
 
 /**
@@ -49,10 +50,8 @@ fun main() = Engine(RenderingMode.OFF_SCREEN).use { engine ->
     val browser = engine.newBrowser()
 
     // Prepare form data, which is going to be overridden.
-    val formData = FormData("key" to "value")
-    val localhost = LoadUrlParams.newBuilder("http://localhost/")
-        .uploadData(formData)
-        .build()
+    val formData = FormData(StringEntry("key", "value"))
+    val localhost = LoadUrlParams("http://localhost/", formData)
 
     // Load URL request using POST method and send form data
     browser.navigation.loadUrlAndWait(localhost)

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ plugins {`
`31`	`31`	`id("org.jetbrains.kotlin.plugin.compose") version "2.0.0"`
`32`	`32`	`}`
`33`	`33`
`34`		`-val jxBrowserVersion by extra { "8.0.0-eap.5" } // The version of JxBrowser used in the examples.`
	`34`	`+val jxBrowserVersion by extra { "8.0.0-eap.6" } // The version of JxBrowser used in the examples.`
`35`	`35`	`val guavaVersion by extra { "29.0-jre" } // Some of the examples use Guava.`
`36`	`36`
`37`	`37`	`allprojects {`