QJniObject Class

メンバ関数のドキュメント

QJniObject が保持するオブジェクトを jobject または T 型として返す。T はJNI Object Types のいずれかです。

QJniObject string = QJniObject::fromString("Hello, JNI");
jstring jstring = string.object<jstring>();

void functionScope()
{
    QString helloString("Hello");
    jstring myJString = 0;
    {
        QJniObject string = QJniObject::fromString(helloString);
        myJString = string.object<jstring>();
    }

   // Ops! myJString is no longer valid.
}

QJniObject::QJniObject()

無効な JNI オブジェクトを構築する。

isValid()も参照 。

[explicit] QJniObject::QJniObject(const char *className)

className のデフォルトコンストラクタを呼び出して、新しい JNI オブジェクトを構築する。

QJniObject myJavaString("java/lang/String");

[explicit] QJniObject::QJniObject(jclass clazz)

clazz のデフォルト・コンストラクタを呼び出して、新しい JNI オブジェクトを構築します。

QJniObject::QJniObject(jobject object)

Javaオブジェクトobject の周りに新しいJNIオブジェクトを構築する。

fromLocalRef()も参照してください 。

[explicit, since 6.4] template <typename... Args> QJniObject::QJniObject(const char *className, Args &&... args)

args を引数としてclassName のコンストラクタを呼び出すことで、新しい JNI オブジェクトを構築する。このコンストラクタは、すべてのargs が既知である場合にのみ利用可能ですJNI Types 。

QJniEnvironment env;
char* str = "Hello";
jstring myJStringArg = env->NewStringUTF(str);
QJniObject myNewJavaString("java/lang/String", myJStringArg);

この関数はQt 6.4で導入されました。

[explicit, since 6.4] template <typename... Args> QJniObject::QJniObject(jclass clazz, Args &&... args)

args を引数としてコンストラクタを呼び出すことにより、clazz から新しい JNI オブジェクトを構築する。このコンストラクタは、すべてのargs が既知である場合にのみ利用可能ですJNI Types 。

QJniEnvironment env;
jclass myClazz = env.findClass("org/qtproject/qt/TestClass");
QJniObject(myClazz, 3);

この関数は Qt 6.4 で導入されました。

[explicit] QJniObject::QJniObject(const char *className, const char *signature, ...)

className のコンストラクタを、signature で後続の引数の型を指定して呼び出すことで、新しい JNI オブジェクトを構築する。

QJniEnvironment env;
char* str = "Hello";
jstring myJStringArg = env->NewStringUTF(str);
QJniObject myNewJavaString("java/lang/String", "(Ljava/lang/String;)V", myJStringArg);

[explicit] QJniObject::QJniObject(jclass clazz, const char *signature, ...)

signature でコンストラクタを呼び出して、clazz から新しい JNI オブジェクトを構築する。

QJniEnvironment env;
jclass myClazz = env.findClass("org/qtproject/qt/TestClass");
QJniObject(myClazz, "(I)V", 3);

[noexcept] QJniObject::~QJniObject()

JNIオブジェクトを破棄し、JNIオブジェクトが保持している参照をすべて解放する。

[since 6.4] template <typename Ret, typename... Args> auto QJniObject::callMethod(const char *methodName, Args &&... args) const

メソッドmethodName を引数args で呼び出し、その値を返す（ただしRet がvoid である場合を除く）。Ret が jobject 型の場合、返される値はQJniObject となる。

QJniObject myJavaString("org/qtproject/qt/TestClass");
jint size = myJavaString.callMethod<jint>("length");

メソッドのシグネチャは、コンパイル時にRet とargs の型から推測されます。

この関数は Qt 6.4 で導入されました。

[since 6.4] template <typename Ret, typename... Args> auto QJniObject::callMethod(const char *methodName, const char *signature, Args &&... args) const

signature でオブジェクトのメソッドmethodName を呼び出し、それに続く引数args の型を指定し、その値を返す（ただしRet がvoid である場合を除く）。Ret が jobject 型の場合、返される値はQJniObject になります。

QJniObject myJavaString("org/qtproject/qt/TestClass");
jint index = myJavaString.callMethod<jint>("indexOf", "(I)I", 0x0051);

この関数は Qt 6.4 で導入されました。

[since 6.4] template <typename Ret, typename... Args> QJniObject QJniObject::callObjectMethod(const char *methodName, Args &&... args) const

JavaオブジェクトのメソッドmethodName を引数args で呼び出し、返されたJavaオブジェクトの新しいQJniObject を返す。

QJniObject myJavaString = QJniObject::fromString("Hello, Java");
QJniObject myJavaString2 = myJavaString1.callObjectMethod<jstring>("toString");

メソッドのシグネチャは、コンパイル時にRet とargs の型から推測されます。

この関数はQt 6.4で導入されました。

QJniObject QJniObject::callObjectMethod(const char *methodName, const char *signature, ...) const

JavaオブジェクトのメソッドmethodName を、signature に続く引数の型を指定して呼び出す。

QJniObject myJavaString = QJniObject::fromString("Hello, Java");
QJniObject mySubstring = myJavaString.callObjectMethod("substring",
                                                       "(II)Ljava/lang/String;", 7, 11);

[static, since 6.7] template <typename Klass, typename Ret, typename... Args> auto QJniObject::callStaticMethod(const char *methodName, Args &&... args)

クラスKlass のスタティック・メソッドmethodName を呼び出し、型Ret の値を返す（ただしRet がvoid である場合を除く）。Ret が jobject 型の場合、返される値はQJniObject となる。

メソッド・シグネチャは、コンパイル時にRet とargs の型から推測されます。Klass は、Java 型への型マッピングが登録された C++ 型である必要があります。

この関数はQt 6.7で導入されました。

[static, since 6.4] template <typename Ret, typename... Args> auto QJniObject::callStaticMethod(const char *className, const char *methodName, Args &&... args)

クラスclassName のスタティック・メソッドmethodName を引数args で呼び出し、型Ret の値を返す（ただしRet がvoid である場合を除く）。Ret が jobject 型の場合、返される値はQJniObject になります。

jint value = QJniObject::callStaticMethod<jint>("MyClass", "staticMethod");

メソッドのシグネチャは、コンパイル時にRet とargs の型から推測されます。

この関数は Qt 6.4 で導入されました。

[static, since 6.4] template <typename Ret, typename... Args> auto QJniObject::callStaticMethod(jclass clazz, const char *methodName, Args &&... args)

clazz の静的メソッドmethodName を呼び出し、Ret 型の値を返す（Ret がvoid でない限り）。Ret が jobject 型の場合、返される値はQJniObject となる。

QJniEnvironment env;
jclass javaMathClass = env.findClass("java/lang/Math");
jdouble randNr = QJniObject::callStaticMethod<jdouble>(javaMathClass, "random");

メソッドのシグネチャは、コンパイル時にRet とargs の型から推測されます。

この関数は Qt 6.4 で導入されました。

[static, since 6.4] template <typename Ret, typename... Args> auto QJniObject::callStaticMethod(jclass clazz, jmethodID methodId, Args &&... args)

clazz クラスからmethodId で識別される静的メソッドを、それに続く引数とともに呼び出し、Ret 型の値を返します（Ret がvoid でない限り）。Ret が jobject 型の場合、返される値はQJniObject になります。

clazz とmethodId が以前の操作で既にキャッシュされている場合に便利です。

QJniEnvironment env;
jclass javaMathClass = env.findClass("java/lang/Math");
jmethodID methodId = env.findStaticMethod(javaMathClass, "max", "(II)I");
if (methodId != 0) {
    jint a = 2;
    jint b = 4;
    jint max = QJniObject::callStaticMethod<jint>(javaMathClass, methodId, a, b);
}

この関数は Qt 6.4 で導入されました。

[static, since 6.4] template <typename Ret, typename... Args> auto QJniObject::callStaticMethod(const char *className, const char *methodName, const char *signature, Args &&... args)

signature に続く引数args の型を指定して、クラスclassName から静的メソッドmethodName を呼び出す。メソッドの結果を返す（ただし、Ret がvoid である場合を除く）。Ret が jobject 型の場合、返される値はQJniObject になります。

jint a = 2;
jint b = 4;
jint max = QJniObject::callStaticMethod<jint>("java/lang/Math", "max", "(II)I", a, b);

この関数は Qt 6.4 で導入されました。

[static] template <typename Ret, typename... Args> auto QJniObject::callStaticMethod(jclass clazz, const char *methodName, const char *signature, Args &&... args)

clazz のスタティック・メソッドmethodName を、後続の引数の型を指定するsignature とともに呼び出す。メソッドの結果を返します（Ret がvoid でない限り）。Ret が jobject 型の場合、返される値はQJniObject になります。

QJniEnvironment env;
jclass javaMathClass = env.findClass("java/lang/Math");
jint a = 2;
jint b = 4;
jint max = QJniObject::callStaticMethod<jint>(javaMathClass, "max", "(II)I", a, b);

[static, since 6.4] template <typename Ret, typename... Args> QJniObject QJniObject::callStaticObjectMethod(const char *className, const char *methodName, Args &&... args)

引数args を渡して、クラスclassName 上の静的メソッドmethodName を呼び出し、返されたJavaオブジェクトに対して新しいQJniObject を返す。

QJniObject string = QJniObject::callStaticObjectMethod<jstring>("CustomClass", "getClassName");

メソッド・シグネチャは、コンパイル時にRet とargs の型から推測されます。

この関数は Qt 6.4 で導入されました。

[static, since 6.4] template <typename Ret, typename... Args> QJniObject QJniObject::callStaticObjectMethod(jclass clazz, const char *methodName, Args &&... args)

引数args を渡し、methodName を持つ静的メソッドをclazz で呼び出し、返された Java オブジェクトの新しいQJniObject を返します。

この関数はQt 6.4で導入されました。

[static] QJniObject QJniObject::callStaticObjectMethod(jclass clazz, jmethodID methodId, ...)

clazz クラスからmethodId で特定される静的メソッドを、それに続く引数とともに呼び出す。clazz とmethodId が以前の操作ですでにキャッシュされている場合に便利です。

QJniEnvironment env;
jclass clazz = env.findClass("java/lang/String");
jmethodID methodId = env.findStaticMethod(clazz, "valueOf", "(I)Ljava/lang/String;");
if (methodId != 0)
    QJniObject str = QJniObject::callStaticObjectMethod(clazz, methodId, 10);

[static] QJniObject QJniObject::callStaticObjectMethod(const char *className, const char *methodName, const char *signature, ...)

signature 、それに続く引数の型を指定して、className クラスからスタティック・メソッドmethodName を呼び出す。

QJniObject thread = QJniObject::callStaticObjectMethod("java/lang/Thread", "currentThread",
                                                       "()Ljava/lang/Thread;");
QJniObject string = QJniObject::callStaticObjectMethod("java/lang/String", "valueOf",
                                                       "(I)Ljava/lang/String;", 10);

[static] QJniObject QJniObject::callStaticObjectMethod(jclass clazz, const char *methodName, const char *signature, ...)

signature 、後続の引数の型を指定して、clazz クラスからスタティック・メソッドmethodName を呼び出す。

[since 6.2] QByteArray QJniObject::className() const

QJniObject が保持するクラスオブジェクトの名前をQByteArray として返します。

この関数は Qt 6.2 で導入されました。

[static, since 6.4] template <typename Class, typename... Args> QJniObject QJniObject::construct(Args &&... args)

Class に相当するJavaクラスのインスタンスを構築し、JNIオブジェクトを含むQJniObject を返す。args の引数は、Java コンストラクタに渡されます。

QJniObject javaString = QJniObject::construct<jstring>();

この関数は、すべてのargs が既知のJNI Types である場合にのみ利用可能です。

この関数は Qt 6.4 で導入されました。

[static] QJniObject QJniObject::fromLocalRef(jobject localRef)

ローカル JNI 参照localRef からQJniObject を作成する。この関数はlocalRef の所有権を取得し、それを解放してから戻る。

jobject localRef = env->GetObjectArrayElement(array, index);
QJniObject element = QJniObject::fromLocalRef(localRef);

[static] QJniObject QJniObject::fromString(const QString &string)

QString string からJava文字列を作成し、その文字列を保持するQJniObject を返す。

QString myQString = "QString";
QJniObject myJavaString = QJniObject::fromString(myQString);

toString()も参照のこと 。

template <typename T> auto QJniObject::getField(const char *fieldName) const

fieldName フィールドの値を取得する。

QJniObject volumeControl("org/qtproject/qt/TestClass");
jint fieldValue = volumeControl.getField<jint>("FIELD_NAME");

template <typename T> QJniObject QJniObject::getObjectField(const char *fieldName) const

フィールドfieldName から JNI オブジェクトを取得する。

QJniObject field = jniObject.getObjectField<jstring>("FIELD_NAME");

QJniObject QJniObject::getObjectField(const char *fieldName, const char *signature) const

フィールドfieldName から JNI オブジェクトをsignature で取得します。

QJniObject field = jniObject.getObjectField("FIELD_NAME", "Ljava/lang/String;");

[static] template <typename Klass, typename T> auto QJniObject::getStaticField(const char *fieldName)

Klass クラスの静的フィールドfieldName から値を取得します。

Klass は、Java 型への型マッピングが登録された C++ 型である必要があります。

[static] template <typename T> auto QJniObject::getStaticField(const char *className, const char *fieldName)

クラスclassName の静的フィールドfieldName から値を取得します。

[static] template <typename T> auto QJniObject::getStaticField(jclass clazz, const char *fieldName)

clazz の静的フィールドfieldName から値を取得する。

[static] template <typename T> QJniObject QJniObject::getStaticObjectField(const char *className, const char *fieldName)

クラスclassName のフィールドfieldName からオブジェクトを取得します。

QJniObject jobj = QJniObject::getStaticObjectField<jstring>("class/with/Fields", "FIELD_NAME");

[static] template <typename T> QJniObject QJniObject::getStaticObjectField(jclass clazz, const char *fieldName)

clazz のフィールドfieldName からオブジェクトを取得する。

QJniObject jobj = QJniObject::getStaticObjectField<jstring>(clazz, "FIELD_NAME");

[static] QJniObject QJniObject::getStaticObjectField(const char *className, const char *fieldName, const char *signature)

クラスclassName からsignature を持つフィールドfieldName から JNI オブジェクトを取得します。

QJniObject jobj = QJniObject::getStaticObjectField("class/with/Fields", "FIELD_NAME",
                                                   "Ljava/lang/String;");

[static] QJniObject QJniObject::getStaticObjectField(jclass clazz, const char *fieldName, const char *signature)

クラスclazz からsignature を持つフィールドfieldName から JNI オブジェクトを取得します。

QJniObject jobj = QJniObject::getStaticObjectField(clazz, "FIELD_NAME", "Ljava/lang/String;");

[static] bool QJniObject::isClassAvailable(const char *className)

Java クラスclassName が利用可能な場合に true を返します。

if (QJniObject::isClassAvailable("java/lang/String")) {
    // condition statement
}

bool QJniObject::isValid() const

このインスタンスが有効な Java オブジェクトを保持している場合に true を返します。

QJniObject qjniObject;                        // ==> isValid() == false
QJniObject qjniObject(0)                      // ==> isValid() == false
QJniObject qjniObject("could/not/find/Class") // ==> isValid() == false

[since 6.2] jclass QJniObject::objectClass() const

QJniObject が保持するクラス・オブジェクトをjclass として返す。

この関数はQt 6.2で導入されました。

template <typename T> void QJniObject::setField(const char *fieldName, T value)

fieldName の値をvalue に設定する。

QJniObject obj;
obj.setField<jint>("AN_INT_FIELD", 10);
jstring myString = ...;
obj.setField<jstring>("A_STRING_FIELD", myString);

template <typename T> void QJniObject::setField(const char *fieldName, const char *signature, T value)

signature でfieldName の値をvalue に設定する。

QJniObject stringArray = ...;
QJniObject obj = ...;
obj.setObjectField<jobjectArray>("KEY_VALUES", "([Ljava/lang/String;)V",
                           stringArray.object<jobjectArray>())

[static] template <typename Klass, typename T> auto QJniObject::setStaticField(const char *fieldName, T value)

クラスKlass の静的フィールドfieldName をvalue に設定します。

Klass は、Java型への型マッピングが登録されたC++型である必要があります。

[static] template <typename T> void QJniObject::setStaticField(const char *className, const char *fieldName, T value)

クラスclassName の静的フィールドfieldName をvalue に設定する。

[static] template <typename T> void QJniObject::setStaticField(jclass clazz, const char *fieldName, T value)

クラスclazz の静的フィールドfieldName をvalue に設定する。

[static] template <typename T> void QJniObject::setStaticField(const char *className, const char *fieldName, const char *signature, T value)

クラスclassName の静的フィールドfieldName を、signature のセッターを使ってvalue に設定します。

[static] template <typename T> void QJniObject::setStaticField(jclass clazz, const char *fieldName, const char *signature, T value)

クラスclazz の静的フィールドfieldName を、signature のセッターを使ってvalue に設定します。

[noexcept, since 6.8] void QJniObject::swap(QJniObject &other)

このオブジェクトをother と交換する。この操作は非常に高速で、失敗することはありません。

この関数は Qt 6.8 で導入されました。

QString QJniObject::toString() const

Javaオブジェクトの文字列表現をQString 。Java Stringオブジェクトでこの関数を呼び出すと、実際の文字列データを取得するのに便利です。

QJniObject string = ...; //  "Hello Java"
QString qstring = string.toString(); // "Hello Java"

fromString()も参照 。

template <typename T, std::enable_if_t<std::is_convertible_v<T, jobject>, bool> = true> QJniObject &QJniObject::operator=(T object)

現在のオブジェクトをobject で置き換える。古いJavaオブジェクトはリリースされる。