QJniObject Class

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

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)

clazz から、引数args を指定してコンストラクタを呼び出すことで、新しい 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, ...)

`signature ` を使用して、後続の引数の型を指定しつつ、className のコンストラクタを呼び出し、新しい 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, ...)

`clazz ` から新しい JNI オブジェクトを生成します。これは、コンストラクタを呼び出し、`signature ` を使用して、その後の引数の型を指定します。

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

[noexcept default] QJniObject::QJniObject(const QJniObject &other)

QJniObject のインスタンスをコピーして生成します。

[noexcept default] QJniObject::QJniObject(QJniObject &&other)

QJniObject のインスタンスをMoveコンストラクタで生成します。

[noexcept] QJniObject::~QJniObject()

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

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

引数args を指定してメソッドmethodName を呼び出し、値を返します（Retがvoid でない場合）。Retがjobject型の場合、返される値はQJniObject となります。

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

メソッドのシグネチャは、コンパイル時に Ret および `args` の型から推論されます。Ret は、値を返す `std::expected` 互換の型、または呼び出されるメソッドによって `any Java exception thrown ` となる型です。

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

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

オブジェクトのメソッド `methodName ` を、signature を引き数として呼び出し、後続の引数の型を `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

引数args を指定して、JavaオブジェクトのメソッドmethodName を呼び出し、返されたJavaオブジェクトに対する新しいQJniObject を返します。

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

メソッドのシグネチャは、コンパイル時に `Ret` および `args` の型から推論されます。`Ret` は、値を返す `std::expected` と互換性のある型、または呼び出されるメソッドによって返される `any Java exception thrown ` である必要があります。

この関数は 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 ReturnType = void, typename... Args > auto QJniObject::callStaticMethod(const char *methodName, Args &&... args)

クラス `Klass ` の静的メソッド `methodName ` を呼び出し、`Ret` 型の値を返します（ただし、`Ret` が `void` の場合は除く）。`Ret` が `jobject` 型の場合、返される値は `QJniObject` になります。

メソッドのシグネチャは、Ret およびargs の型からコンパイル時に推論されます。Klass は、Java 型への登録済み型マッピングを持つ C++ 型である必要があります。Ret は、値を返すstd::expected 互換の型、または呼び出されるメソッドによって返されるany Java exception thrown であることができます。

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

[static, since 6.4] template <typename ReturnType = void, 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 の型から推論されます。Ret は、値を返すstd::expected と互換性のある型、または呼び出されたメソッドによって指定されるany Java exception thrown である可能性があります。

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

[static, since 6.4] template <typename ReturnType = void, 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 の型から推論されます。Ret は、値を返すstd::expected 互換の型、または呼び出されるメソッドによってany Java exception thrown となる型です。

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

[static, since 6.4] template <typename ReturnType = void, 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 = void, typename... Args> auto QJniObject::callStaticMethod(const char *className, const char *methodName, const char *signature, Args &&... args)

クラス `className ` の静的メソッド `methodName ` を、signature を引き数として呼び出し、後続の引数の型をargs で指定します。メソッドの結果を返します（ただし、`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 = void, 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)

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

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

メソッドのシグネチャは、コンパイル時に `Ret` および `args` の型から推論されます。`Ret` は、値を返す `std::expected` 互換の型、または呼び出されるメソッドによって返される `any Java exception thrown ` です。

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

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

clazz に対して、methodName を含む静的メソッドを呼び出し、引数としてargs を渡し、返された 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, ...)

クラス `className ` の静的メソッド `methodName ` を呼び出し、signature を使用して、その後に続く引数の型を指定します。

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, ...)

クラス `clazz ` の静的メソッド `methodName ` を、signature を使用して呼び出し、後続の引数の型を指定します。

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

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

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

[static, since 6.4] template <typename Class, typename... Args> auto 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 Type> 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

`signature` を使用して、フィールド `fieldName ` から JNI オブジェクトを取得します。

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 Type> auto QJniObject::getStaticField(const char *className, const char *fieldName)

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

[static] template <typename Type> 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` のフィールド `fieldName ` から、`signature ` を持つ 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` のフィールド `fieldName ` から、signature を持つ 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

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.
    QString myQtString = QJniObject(myJString).toString();
}

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

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

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

template <typename Ret = void, typename Type> auto QJniObject::setField(const char *fieldName, Type value)

fieldName の値をvalue に設定します。

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

template <typename Ret = void, typename Type> auto QJniObject::setField(const char *fieldName, const char *signature, Type 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 Ret = void, typename Type > auto QJniObject::setStaticField(const char *fieldName, Type value)

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

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

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

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

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

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

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

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

[static] template <typename Ret = void, typename Type> auto QJniObject::setStaticField(jclass clazz, const char *fieldName, const char *signature, Type 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()も参照してください 。

[noexcept default] QJniObject &QJniObject::operator=(QJniObject &&other)

other をこのQJniObject インスタンスに割り当てます。

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

現在のオブジェクトを `object` に置き換えます。元の Java オブジェクトは解放されます。

[noexcept default] QJniObject &QJniObject::operator=(const QJniObject &other)

other をこのQJniObject インスタンスにコピーして割り当てます。