java: export util/java from google3

Author: Mizux

MODULE.bazel

@@ -107,8 +107,11 @@ JUNIT_JUPITER_VERSION = "5.9.2"
 maven = use_extension("@rules_jvm_external//:extensions.bzl", "maven")
 maven.install(
     artifacts = [
-        "com.google.truth:truth:0.32",
+        "com.google.errorprone:error_prone_type_annotations:2.46.0",
+        "com.google.truth:truth:1.4.2",
+        "com.google.truth.extensions:truth-proto-extension:1.4.2",
         "net.java.dev.jna:jna:5.14.0",
+        "org.jspecify:jspecify:1.0.0",
         "org.junit.platform:junit-platform-launcher:%s" % JUNIT_PLATFORM_VERSION,
         "org.junit.platform:junit-platform-reporting:%s" % JUNIT_PLATFORM_VERSION,
         "org.junit.jupiter:junit-jupiter-api:%s" % JUNIT_JUPITER_VERSION,

cmake/java.cmake

@@ -267,15 +267,19 @@ foreach(SUBPROJECT IN ITEMS
  init
  linear_solver
  constraint_solver
- routing
- sat
- util)
+ routing)
   add_subdirectory(ortools/${SUBPROJECT}/java)
   target_link_libraries(jni${JAVA_ARTIFACT} PRIVATE jni${SUBPROJECT})
 endforeach()
+# from ortools/linear_solver/java
 target_link_libraries(jni${JAVA_ARTIFACT} PRIVATE jnimodelbuilder)
-target_link_libraries(jni${JAVA_ARTIFACT} PRIVATE ortools::util_java_jni_helper)
+add_subdirectory(ortools/sat/java)
+target_link_libraries(jni${JAVA_ARTIFACT} PRIVATE jnisat)
 target_link_libraries(jni${JAVA_ARTIFACT} PRIVATE jni_cp_model_proto)
+add_subdirectory(ortools/util/java)
+target_link_libraries(jni${JAVA_ARTIFACT} PRIVATE util_java_jni_helper)
+target_link_libraries(jni${JAVA_ARTIFACT} PRIVATE jni_sorted_interval_list)
+target_link_libraries(jni${JAVA_ARTIFACT} PRIVATE jni_java_swig_solve_interrupter)
 
 #################################
 ##  Java Native Maven Package  ##
@@ -569,6 +573,13 @@ add_custom_target(java_deploy
   WORKING_DIRECTORY ${JAVA_PROJECT_DIR})
 add_dependencies(java_deploy java_package)
 
+#################
+##  Java Test  ##
+#################
+if(BUILD_TESTING)
+  add_subdirectory(ortools/javatests/com/google/ortools javatests/ortools)
+endif()
+
 ###############
 ## Doc rules ##
 ###############

ortools/java/com/google/ortools/BUILD.bazel

@@ -30,6 +30,7 @@ cc_binary(
         "//ortools/linear_solver/java:modelbuilder_cc",
         "//ortools/sat/java:cp_model_proto_cc",
         "//ortools/sat/java:sat_cc",
+        "//ortools/util/java:java_swig_solve_interrupter_swig_cc",
         "//ortools/util/java:sorted_interval_list_cc",
         "//ortools/util/java:wrappers_test_message_cc",
     ],
@@ -44,15 +45,16 @@ cc_binary(
     }),
     visibility = ["//visibility:public"],
     deps = [
-        "@rules_jni//jni:libjvm",
         "//ortools/algorithms/java:knapsacksolver_cc",
         "//ortools/graph/java:graph_cc",
         "//ortools/init/java:init_cc",
         "//ortools/linear_solver/java:modelbuilder_cc",
         "//ortools/sat/java:cp_model_proto_cc",
         "//ortools/sat/java:sat_cc",
+        "//ortools/util/java:java_swig_solve_interrupter_swig_cc",
         "//ortools/util/java:sorted_interval_list_cc",
         "//ortools/util/java:wrappers_test_message_cc",
+        "@rules_jni//jni:libjvm",
     ],
 )
 
@@ -65,15 +67,16 @@ cc_binary(
     }),
     visibility = ["//visibility:public"],
     deps = [
-        "@rules_jni//jni:libjvm",
         "//ortools/algorithms/java:knapsacksolver_cc",
         "//ortools/graph/java:graph_cc",
         "//ortools/init/java:init_cc",
         "//ortools/linear_solver/java:modelbuilder_cc",
         "//ortools/sat/java:cp_model_proto_cc",
         "//ortools/sat/java:sat_cc",
+        "//ortools/util/java:java_swig_solve_interrupter_swig_cc",
         "//ortools/util/java:sorted_interval_list_cc",
         "//ortools/util/java:wrappers_test_message_cc",
+        "@rules_jni//jni:libjvm",
     ],
 )
 

ortools/java/com/google/ortools/util/BUILD.bazel

@@ -0,0 +1,54 @@
+# Copyright 2010-2025 Google LLC
+# Licensed 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.
+
+load("@rules_java//java:java_library.bzl", "java_library")
+
+java_library(
+    name = "interruptable",
+    srcs = ["Interruptable.java"],
+    visibility = ["//visibility:public"],
+)
+
+java_library(
+    name = "solve_interrupter",
+    srcs = ["SolveInterrupter.java"],
+    visibility = ["//visibility:public"],
+    deps = [
+        ":interruptable",
+        "@maven//:com_google_errorprone_error_prone_annotations",
+    ],
+)
+
+java_library(
+    name = "proto_duration_conversion",
+    srcs = ["ProtoDurationConversion.java"],
+    visibility = [
+        "//javatests/com/google/wrappers/util/operationsresearch:__subpackages__",
+        "//ortools:__subpackages__",
+    ],
+    deps = [
+        "@maven//:com_google_protobuf_protobuf_java",
+        "@maven//:com_google_protobuf_protobuf_java_util",
+    ],
+)
+
+java_library(
+    name = "scoped_swig_interrupter",
+    srcs = ["ScopedSwigInterrupter.java"],
+    visibility = ["//ortools:__subpackages__"],
+    deps = [
+        ":interruptable",
+        "//ortools/util/java:java_swig_solve_interrupter_swig",  # buildcleaner: keep
+        "@maven//:org_jspecify_jspecify",
+    ],
+)

ortools/java/com/google/ortools/util/Interruptable.java

@@ -0,0 +1,24 @@
+// Copyright 2010-2025 Google LLC
+// Licensed 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.
+
+package com.google.ortools.util;
+
+/**
+ * Accepts notification to interrupt computation.
+ *
+ * @see SolveInterrupter
+ */
+public interface Interruptable {
+  /** A notification that computation should stop as soon as possible. */
+  void interrupt();
+}

ortools/java/com/google/ortools/util/ProtoDurationConversion.java

@@ -0,0 +1,45 @@
+// Copyright 2010-2025 Google LLC
+// Licensed 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.
+
+package com.google.ortools.util;
+
+import com.google.protobuf.util.Durations;
+
+/**
+ * A utility class that provides conversions between {@link com.google.protobuf.Duration} and {@link
+ * java.time.Duration}.
+ */
+public final class ProtoDurationConversion {
+  private ProtoDurationConversion() {}
+
+  /**
+   * Converts a {@link com.google.protobuf.Duration} to a {@link java.time.Duration}.
+   *
+   * @throws ArithmeticException if it does not fit in a {@link java.time.Duration}.
+   */
+  public static java.time.Duration toJavaDuration(com.google.protobuf.Duration protoDuration) {
+    // Note that java.time.Duration.ofSeconds() handles negative nanos seconds correctly.
+    return java.time.Duration.ofSeconds(protoDuration.getSeconds(), protoDuration.getNanos());
+  }
+
+  /**
+   * Converts a {@link java.time.Duration} to a {@link com.google.protobuf.Duration}.
+   *
+   * @throws ArithmeticException if the given duration does not fit in {@link long} in nanoseconds.
+   */
+  public static com.google.protobuf.Duration toProtoDuration(java.time.Duration duration) {
+    // Note that here we don't support cases of durations that don't fit in `long` when using
+    // nanoseconds.
+    return Durations.fromNanos(duration.toNanos());
+  }
+}

ortools/java/com/google/ortools/util/ScopedSwigInterrupter.java

@@ -0,0 +1,69 @@
+// Copyright 2010-2025 Google LLC
+// Licensed 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.
+
+package com.google.ortools.util;
+
+import org.jspecify.annotations.Nullable;
+
+/**
+ * Wraps a JavaSwigSolveInterrupter in an AutoCloseable so SWIGed Cpp object can be cleaned up using
+ * try-with-resources.
+ *
+ * <p>Note that the underlying JavaSwigSolveInterrupter is nullable.
+ *
+ * <p>This class is not thread-safe.
+ */
+public class ScopedSwigInterrupter implements AutoCloseable, Interruptable {
+  // Use nullable instead of optional because the JniSolver.cppSolve() wants a nullable value.
+  @Nullable JavaSwigSolveInterrupter swigInterrupter;
+
+  /** The underlying {@link JavaSwigSolveInterrupter} is created only when {@code isPresent.} */
+  public ScopedSwigInterrupter(boolean isPresent) {
+    swigInterrupter = isPresent ? new JavaSwigSolveInterrupter() : null;
+  }
+
+  /** The underlying {@link JavaSwigSolveInterrupter} is created. */
+  public ScopedSwigInterrupter() {
+    this(true);
+  }
+
+  /**
+   * Returns the underlying SWIGed interrupter, which is non-null if and only if the input user
+   * interrupter is non-null.
+   *
+   * <p>The returned object must not be used after calling {@link #close()}, doing so will cause a
+   * crash or memory corruption in C++.
+   */
+  public @Nullable JavaSwigSolveInterrupter getSwigInterrupter() {
+    return swigInterrupter;
+  }
+
+  @Override
+  public void close() {
+    if (swigInterrupter != null) {
+      swigInterrupter.delete();
+      swigInterrupter = null;
+    }
+  }
+
+  /**
+   * Interrupts the underlying {@link JavaSwigSolveInterrupter}, has no effect if it is initialized
+   * as null.
+   */
+  @Override
+  public void interrupt() {
+    if (swigInterrupter != null) {
+      swigInterrupter.interrupt();
+    }
+  }
+}