[java] specify nullability in package org.openqa.selenium.bidi.script (#17062)

specify nullability in package `org.openqa.selenium.bidi.script`

Author: asolntsev

java/src/org/openqa/selenium/bidi/browsingcontext/HistoryUpdated.java

@@ -47,7 +47,7 @@ public static HistoryUpdated fromJson(JsonInput input) {
           break;
 
         case "timestamp":
-          timestamp = input.read(long.class);
+          timestamp = input.read(Long.class);
           break;
 
         case "url":

java/src/org/openqa/selenium/bidi/permissions/PermissionState.java

@@ -17,10 +17,11 @@
 
 package org.openqa.selenium.bidi.permissions;
 
-import org.jspecify.annotations.NullMarked;
-import org.jspecify.annotations.Nullable;
-
-@NullMarked
+/**
+ * @see <a
+ *     href="https://www.w3.org/TR/permissions/#webdriver-bidi-type-permissions-PermissionState">BiDi
+ *     spec</a>
+ */
 public enum PermissionState {
   GRANTED("granted"),
   DENIED("denied"),
@@ -37,14 +38,12 @@ public String toString() {
     return state;
   }
 
-  public static @Nullable PermissionState findByName(String name) {
-    PermissionState result = null;
+  public static PermissionState findByName(String name) {
     for (PermissionState state : values()) {
       if (state.toString().equalsIgnoreCase(name)) {
-        result = state;
-        break;
+        return state;
       }
     }
-    return result;
+    throw new IllegalArgumentException("Unsupported permission state: " + name);
   }
 }

java/src/org/openqa/selenium/bidi/permissions/package-info.java

@@ -0,0 +1,21 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+@NullMarked
+package org.openqa.selenium.bidi.permissions;
+
+import org.jspecify.annotations.NullMarked;

java/src/org/openqa/selenium/bidi/script/ArrayLocalValue.java

@@ -20,6 +20,10 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * @see <a href="https://www.w3.org/TR/webdriver-bidi/#cddl-type-scriptarraylocalvalue">BiDi
+ *     spec</a>
+ */
 public class ArrayLocalValue extends LocalValue {
 
   private final List<LocalValue> value;

java/src/org/openqa/selenium/bidi/script/CallFunctionParameters.java

@@ -21,6 +21,10 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * @see <a href="https://www.w3.org/TR/webdriver-bidi/#cddl-type-scriptcallfunctionparameters">BiDi
+ *     spec</a>
+ */
 public class CallFunctionParameters {
 
   private final Map<String, Object> map = new HashMap<>();

java/src/org/openqa/selenium/bidi/script/ChannelValue.java

@@ -17,43 +17,43 @@
 
 package org.openqa.selenium.bidi.script;
 
-import java.util.Collections;
 import java.util.Map;
 import java.util.TreeMap;
+import org.jspecify.annotations.Nullable;
 
+/**
+ * @see <a href="https://www.w3.org/TR/webdriver-bidi/#type-script-ChannelValue">BiDi spec</a>
+ */
 public class ChannelValue extends LocalValue {
 
   private final String channelId;
-  private SerializationOptions options;
-
-  private ResultOwnership resultOwnership;
+  private final @Nullable SerializationOptions options;
+  private final @Nullable ResultOwnership resultOwnership;
 
   public ChannelValue(String channelId) {
-    this.channelId = channelId;
+    this(channelId, null, null);
   }
 
   public ChannelValue(String channelId, SerializationOptions options) {
-    this.channelId = channelId;
-    this.options = options;
+    this(channelId, options, null);
   }
 
   public ChannelValue(String channelId, ResultOwnership resultOwnership) {
-    this.channelId = channelId;
-    this.resultOwnership = resultOwnership;
+    this(channelId, null, resultOwnership);
   }
 
-  ChannelValue(String channelId, SerializationOptions options, ResultOwnership resultOwnership) {
+  ChannelValue(
+      String channelId,
+      @Nullable SerializationOptions options,
+      @Nullable ResultOwnership resultOwnership) {
     this.channelId = channelId;
     this.options = options;
     this.resultOwnership = resultOwnership;
   }
 
   @Override
   public Map<String, Object> toJson() {
-    Map<String, Object> toReturn = new TreeMap<>();
-
     Map<String, Object> channelProperties = new TreeMap<>();
-
     channelProperties.put("channel", channelId);
 
     if (options != null) {
@@ -64,9 +64,6 @@ public Map<String, Object> toJson() {
       channelProperties.put("ownership", resultOwnership);
     }
 
-    toReturn.put("type", "channel");
-    toReturn.put("value", channelProperties);
-
-    return Collections.unmodifiableMap(toReturn);
+    return Map.of("type", "channel", "value", channelProperties);
   }
 }

java/src/org/openqa/selenium/bidi/script/ExceptionDetails.java

@@ -17,10 +17,7 @@
 
 package org.openqa.selenium.bidi.script;
 
-import static java.util.Collections.unmodifiableMap;
-
-import java.util.Map;
-import java.util.TreeMap;
+import org.openqa.selenium.internal.Require;
 import org.openqa.selenium.json.JsonInput;
 
 public class ExceptionDetails {
@@ -55,15 +52,15 @@ public static ExceptionDetails fromJson(JsonInput input) {
     while (input.hasNext()) {
       switch (input.nextName()) {
         case "columnNumber":
-          columnNumber = input.read(Long.class);
+          columnNumber = input.readNonNull(Long.class);
           break;
 
         case "exception":
           exception = input.read(RemoteValue.class);
           break;
 
         case "lineNumber":
-          lineNumber = input.read(Long.class);
+          lineNumber = input.readNonNull(Long.class);
           break;
 
         case "stackTrace":
@@ -82,7 +79,12 @@ public static ExceptionDetails fromJson(JsonInput input) {
 
     input.endObject();
 
-    return new ExceptionDetails(columnNumber, exception, lineNumber, stackTrace, text);
+    return new ExceptionDetails(
+        columnNumber,
+        Require.nonNull("exception", exception),
+        lineNumber,
+        Require.nonNull("stackTrace", stackTrace),
+        Require.nonNull("text", text));
   }
 
   public long getColumnNumber() {
@@ -104,15 +106,4 @@ public StackTrace getStacktrace() {
   public String getText() {
     return this.text;
   }
-
-  private Map<String, Object> toJson() {
-    Map<String, Object> toReturn = new TreeMap<>();
-    toReturn.put("columnNumber", this.columnNumber);
-    toReturn.put("exception", this.exception);
-    toReturn.put("lineNumber", this.lineNumber);
-    toReturn.put("stacktrace", this.stacktrace);
-    toReturn.put("text", this.text);
-
-    return unmodifiableMap(toReturn);
-  }
 }