Throw RuntimeExceptions instead of AssertionError in NLClassifier

PiperOrigin-RevId: 401316443

Author: lu-wang-g

tensorflow_lite_support/java/src/java/org/tensorflow/lite/task/text/nlclassifier/NLClassifier.java

@@ -209,59 +209,61 @@ public abstract static class Builder {
   private static final String NL_CLASSIFIER_NATIVE_LIBNAME = "task_text_jni";
 
   /**
-   * Constructor to initialize the JNI with a pointer from C++.
+   * Creates {@link NLClassifier} from default {@link NLClassifierOptions}.
    *
-   * @param nativeHandle a pointer referencing memory allocated in C++.
-   */
-  protected NLClassifier(long nativeHandle) {
-    super(nativeHandle);
-  }
-
-  /**
-   * Create {@link NLClassifier} from default {@link NLClassifierOptions}.
-   *
-   * @param context Android context.
-   * @param pathToModel Path to the classification model relative to asset dir.
-   * @return {@link NLClassifier} instance.
-   * @throws IOException If model file fails to load.
+   * @param context Android context
+   * @param modelPath path to the classification model relative to asset dir
+   * @return an {@link NLClassifier} instance
+   * @throws IOException if model file fails to load
+   * @throws IllegalArgumentException if an argument is invalid
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    */
-  public static NLClassifier createFromFile(Context context, String pathToModel)
-      throws IOException {
-    return createFromFileAndOptions(context, pathToModel, NLClassifierOptions.builder().build());
+  public static NLClassifier createFromFile(Context context, String modelPath) throws IOException {
+    return createFromFileAndOptions(context, modelPath, NLClassifierOptions.builder().build());
   }
 
   /**
-   * Create {@link NLClassifier} from default {@link NLClassifierOptions}.
+   * Creates {@link NLClassifier} from default {@link NLClassifierOptions}.
    *
-   * @param modelFile The classification model {@link File} instance.
-   * @return {@link NLClassifier} instance.
-   * @throws IOException If model file fails to load.
+   * @param modelFile the classification model {@link File} instance
+   * @return an {@link NLClassifier} instance
+   * @throws IOException if model file fails to load
+   * @throws IllegalArgumentException if an argument is invalid
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    */
   public static NLClassifier createFromFile(File modelFile) throws IOException {
     return createFromFileAndOptions(modelFile, NLClassifierOptions.builder().build());
   }
 
   /**
-   * Create {@link NLClassifier} from {@link NLClassifierOptions}.
+   * Creates {@link NLClassifier} from {@link NLClassifierOptions}.
    *
    * @param context Android context
-   * @param pathToModel Path to the classification model relative to asset dir.
-   * @param options Configurations for the model.
-   * @return {@link NLClassifier} instance.
-   * @throws IOException If model file fails to load.
+   * @param modelPath path to the classification model relative to asset dir
+   * @param options configurations for the model.
+   * @return an {@link NLClassifier} instance
+   * @throws IOException if model file fails to load
+   * @throws IllegalArgumentException if an argument is invalid
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    */
   public static NLClassifier createFromFileAndOptions(
-      Context context, String pathToModel, NLClassifierOptions options) throws IOException {
-    return createFromBufferAndOptions(TaskJniUtils.loadMappedFile(context, pathToModel), options);
+      Context context, String modelPath, NLClassifierOptions options) throws IOException {
+    return createFromBufferAndOptions(TaskJniUtils.loadMappedFile(context, modelPath), options);
   }
 
   /**
-   * Create {@link NLClassifier} from {@link NLClassifierOptions}.
+   * Creates {@link NLClassifier} from {@link NLClassifierOptions}.
    *
-   * @param modelFile The classification model {@link File} instance.
-   * @param options Configurations for the model.
-   * @return {@link NLClassifier} instance.
-   * @throws IOException If model file fails to load.
+   * @param modelFile the classification model {@link File} instance
+   * @param options configurations for the model
+   * @return an {@link NLClassifier} instance
+   * @throws IOException if model file fails to load
+   * @throws IllegalArgumentException if an argument is invalid
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    */
   public static NLClassifier createFromFileAndOptions(
       File modelFile, final NLClassifierOptions options) throws IOException {
@@ -284,12 +286,14 @@ public long createHandle() {
   }
 
   /**
-   * Create {@link NLClassifier} with a model {@link ByteBuffer} and {@link NLClassifierOptions}.
+   * Creates {@link NLClassifier} with a model {@link ByteBuffer} and {@link NLClassifierOptions}.
    *
    * @param modelBuffer a direct {@link ByteBuffer} or a {@link MappedByteBuffer} of the
    *     classification model
-   * @param options Configurations for the model
+   * @param options configurations for the model
    * @return {@link NLClassifier} instance
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    * @throws IllegalArgumentException if the model buffer is not a direct {@link ByteBuffer} or a
    *     {@link MappedByteBuffer}
    */
@@ -316,15 +320,29 @@ public long createHandle() {
   }
 
   /**
-   * Perform classification on a string input, returns classified {@link Category}s.
+   * Performs classification on a string input, returns classified {@link Category}s.
    *
-   * @param text input text to the model.
-   * @return A list of Category results.
+   * @param text input text to the model
+   * @return a list of Category results
    */
   public List<Category> classify(String text) {
     return classifyNative(getNativeHandle(), text);
   }
 
+  /**
+   * Constructor to initialize the JNI with a pointer from C++.
+   *
+   * @param nativeHandle a pointer referencing memory allocated in C++.
+   */
+  protected NLClassifier(long nativeHandle) {
+    super(nativeHandle);
+  }
+
+  @Override
+  protected void deinit(long nativeHandle) {
+    deinitJni(nativeHandle);
+  }
+
   private static native long initJniWithByteBuffer(
       NLClassifierOptions options, ByteBuffer modelBuffer, long baseOptionsHandle);
 
@@ -333,11 +351,6 @@ private static native long initJniWithFileDescriptor(
 
   private static native List<Category> classifyNative(long nativeHandle, String text);
 
-  @Override
-  protected void deinit(long nativeHandle) {
-    deinitJni(nativeHandle);
-  }
-
   /**
    * Native implementation to release memory pointed by the pointer.
    *

tensorflow_lite_support/java/src/native/task/text/nlclassifier/nl_classifier_jni.cc

@@ -32,9 +32,9 @@ extern std::unique_ptr<OpResolver> CreateOpResolver();
 
 namespace {
 
+using ::tflite::support::utils::GetExceptionClassNameForStatusCode;
 using ::tflite::support::utils::GetMappedFileBuffer;
 using ::tflite::support::utils::JStringToString;
-using ::tflite::support::utils::kAssertionError;
 using ::tflite::support::utils::kInvalidPointer;
 using ::tflite::support::utils::ThrowException;
 using ::tflite::task::core::BaseOptions;
@@ -90,6 +90,8 @@ NLClassifierOptions ConvertToProtoOptions(JNIEnv* env,
   return proto_options;
 }
 
+}  // namespace
+
 extern "C" JNIEXPORT void JNICALL
 Java_org_tensorflow_lite_task_text_nlclassifier_NLClassifier_deinitJni(
     JNIEnv* env, jobject thiz, jlong native_handle) {
@@ -113,9 +115,10 @@ Java_org_tensorflow_lite_task_text_nlclassifier_NLClassifier_initJniWithByteBuff
   if (classifier_or.ok()) {
     return reinterpret_cast<jlong>(classifier_or->release());
   } else {
-    ThrowException(env, kAssertionError,
-                   "Error occurred when initializing NLClassifier: %s",
-                   classifier_or.status().message().data());
+    ThrowException(
+        env, GetExceptionClassNameForStatusCode(classifier_or.status().code()),
+        "Error occurred when initializing NLClassifier: %s",
+        classifier_or.status().message().data());
     return kInvalidPointer;
   }
 }
@@ -138,9 +141,10 @@ Java_org_tensorflow_lite_task_text_nlclassifier_NLClassifier_initJniWithFileDesc
   if (classifier_or.ok()) {
     return reinterpret_cast<jlong>(classifier_or->release());
   } else {
-    ThrowException(env, kAssertionError,
-                   "Error occurred when initializing NLClassifier: %s",
-                   classifier_or.status().message().data());
+    ThrowException(
+        env, GetExceptionClassNameForStatusCode(classifier_or.status().code()),
+        "Error occurred when initializing NLClassifier: %s",
+        classifier_or.status().message().data());
     return kInvalidPointer;
   }
 }
@@ -150,5 +154,3 @@ Java_org_tensorflow_lite_task_text_nlclassifier_NLClassifier_classifyNative(
     JNIEnv* env, jclass thiz, jlong native_handle, jstring text) {
   return RunClassifier(env, native_handle, text);
 }
-
-}  // namespace