test/hotspot/jtreg/vmTestbase/nsk/share/jni/README
changeset 49934 44839fbb20db
child 51941 0f7d0bb6cfe2
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/hotspot/jtreg/vmTestbase/nsk/share/jni/README	Mon Apr 30 18:10:24 2018 -0700
@@ -0,0 +1,61 @@
+Copyright (c) 2003, 2018, Oracle and/or its affiliates. All rights reserved.
+DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+
+This code is free software; you can redistribute it and\\\/or modify it
+under the terms of the GNU General Public License version 2 only, as
+published by the Free Software Foundation.
+This code is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+version 2 for more details (a copy is included in the LICENSE file that
+accompanied this code).
+
+You should have received a copy of the GNU General Public License version
+2 along with this work; if not, write to the Free Software Foundation,
+Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+or visit www.oracle.com if you need additional information or have any
+questions.
+
+---------------------------------------------------------------------------------
+
+This directory contains source files of testbase_nsk JNI framework,
+which provides support for JNI tests and accessing JNI environment.
+
+    Source files:
+        jni_tools.h
+        jni_tools.c
+
+    Naming conventions:
+        macroses:  NSK_JNI_*
+        functions: nsk_JNI_*
+
+---------------------------------------------------------------------------------
+
+jni_tools.h
+
+Provides functions and macroses for invocation of JNI functions
+and checking JNI errors and pending exceptions:
+
+    NSK_JNI_VERIFY(jni, action)
+    NSK_JNI_VERIFY_NEGATIVE(jni, action)
+
+Typical example of usage of NSK_JNI_VERIFY and NSK_CPP_STUB macroses
+for invokation of JNI functions:
+
+    // jni->FindClass(jni, class_name)
+    if (!NSK_JNI_VERIFY(jni,
+            NSK_CPP_STUB2(FindClass, jni, class_name) != NULL)) {
+        return JNI_ERR;
+    }
+
+or with saving obtained data:
+
+    // cls = jni->FindClass(jni, class_name)
+    if (!NSK_JNI_VERIFY(jni, (cls =
+            NSK_CPP_STUB2(FindClass, jni, class_name)) != NULL)) {
+        return JNI_ERR;
+    }
+
+---------------------------------------------------------------------------------