QJniObject Class

Documentation des fonctions membres

QJniObject::QJniObject()

Construit un objet JNI invalide.

Voir aussi isValid().

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

Construit un nouvel objet JNI en appelant le constructeur par défaut de className.

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

[explicit] QJniObject::QJniObject(jclass clazz)

Construit un nouvel objet JNI en appelant le constructeur par défaut de clazz.

QJniObject::QJniObject(jobject object)

Construit un nouvel objet JNI autour de l'objet Java object.

Voir également fromLocalRef().

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

Construit un nouvel objet JNI en appelant le constructeur de className avec les arguments args. Ce constructeur n'est disponible que si tous les args sont connus JNI Types.

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

Cette fonction a été introduite dans Qt 6.4.

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

Construit un nouvel objet JNI à partir de clazz en appelant le constructeur avec les arguments args. Ce constructeur n'est disponible que si tous les args sont connus JNI Types.

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

Cette fonction a été introduite dans Qt 6.4.

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

Construit un nouvel objet JNI en appelant le constructeur de className avec signature spécifiant les types des arguments suivants.

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

Construit un nouvel objet JNI à partir de clazz en appelant le constructeur avec signature spécifiant les types des arguments suivants.

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

[noexcept] QJniObject::~QJniObject()

Détruit l'objet JNI et libère toutes les références détenues par l'objet JNI.

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

Appelle la méthode methodName avec les arguments args et renvoie la valeur (sauf si Ret est void). Si Ret est un type jobject, la valeur renvoyée sera un QJniObject.

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

La signature de la méthode est déduite à la compilation à partir de Ret et des types de args. Ret peut être un type compatible avec std::expected qui renvoie une valeur, ou any Java exception thrown par la méthode appelée.

Cette fonction a été introduite dans Qt 6.4.

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

Appelle la méthode de l'objet methodName avec signature spécifiant les types des arguments suivants args, et renvoie la valeur (sauf si Ret est void). Si Ret est un type jobject, la valeur renvoyée sera QJniObject.

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

Cette fonction a été introduite dans Qt 6.4.

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

Appelle la méthode des objets Java methodName avec les arguments args et renvoie un nouveau QJniObject pour l'objet Java renvoyé.

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

La signature de la méthode est déduite au moment de la compilation à partir de Ret et des types de args. Ret peut être un type compatible avec std::expected qui renvoie une valeur, ou any Java exception thrown par la méthode appelée.

Cette fonction a été introduite dans Qt 6.4.

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

Appelle la méthode de l'objet Java methodName avec signature spécifiant les types des arguments suivants.

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)

Appelle la méthode statique methodName sur la classe Klass et renvoie la valeur du type Ret (sauf si Ret est void). Si Ret est un type jobject, la valeur renvoyée sera QJniObject.

La signature de la méthode est déduite au moment de la compilation à partir de Ret et des types de args. Klass doit être un type C++ avec une correspondance de type enregistrée vers un type Java. Ret peut être un type compatible avec std::expected qui renvoie une valeur, ou any Java exception thrown par la méthode appelée.

Cette fonction a été introduite dans Qt 6.7.

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

Appelle la méthode statique methodName sur la classe className avec les arguments args, et renvoie la valeur du type Ret (sauf si Ret est void). Si Ret est un type jobject, la valeur renvoyée sera QJniObject.

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

La signature de la méthode est déduite à la compilation à partir de Ret et des types de args. Ret peut être un type compatible avec std::expected qui renvoie une valeur, ou any Java exception thrown par la méthode appelée.

Cette fonction a été introduite dans Qt 6.4.

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

Appelle la méthode statique methodName sur clazz et renvoie la valeur du type Ret (sauf si Ret est void). Si Ret est un type jobject, la valeur renvoyée sera QJniObject.

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

La signature de la méthode est déduite à la compilation à partir de Ret et des types de args. Ret peut être un type compatible avec std::expected qui renvoie une valeur, ou any Java exception thrown par la méthode appelée.

Cette fonction a été introduite dans Qt 6.4.

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

Appelle la méthode statique identifiée par methodId de la classe clazz avec tous les arguments suivants, et renvoie la valeur du type Ret (sauf si Ret est void). Si Ret est un type jobject, la valeur renvoyée sera QJniObject.

Utile lorsque clazz et methodId ont déjà été mis en cache lors d'opérations précédentes.

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);
}

Cette fonction a été introduite dans 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)

Appelle la méthode statique methodName de la classe className avec signature spécifiant les types des arguments suivants args. Renvoie le résultat de la méthode (sauf si Ret est void). Si Ret est un type jobject, la valeur renvoyée sera un QJniObject.

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

Cette fonction a été introduite dans Qt 6.4.

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

Appelle la méthode statique methodName à partir de clazz, signature spécifiant les types des arguments suivants. Renvoie le résultat de la méthode (sauf si Ret est void). Si Ret est un type jobject, la valeur renvoyée sera un 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)

Appelle la méthode statique avec methodName sur la classe className, en passant des arguments args, et renvoie un nouveau QJniObject pour l'objet Java renvoyé.

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

La signature de la méthode est déduite au moment de la compilation à partir de Ret et des types de args. Ret peut être un type compatible avec std::expected qui renvoie une valeur, ou any Java exception thrown par la méthode appelée.

Cette fonction a été introduite dans Qt 6.4.

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

Appelle la méthode statique avec methodName sur clazz, en passant les arguments args, et renvoie un nouveau QJniObject pour l'objet Java renvoyé.

Cette fonction a été introduite dans Qt 6.4.

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

Appelle la méthode statique identifiée par methodId de la classe clazz avec tous les arguments suivants. Utile lorsque clazz et methodId ont déjà été mis en cache lors d'opérations précédentes.

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

Appelle la méthode statique methodName à partir de la classe className, signature spécifiant les types des arguments suivants.

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

Appelle la méthode statique methodName de la classe clazz, signature spécifiant les types des arguments suivants.

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

Renvoie le nom de l'objet de classe détenu par QJniObject en tant que QByteArray.

Cette fonction a été introduite dans Qt 6.2.

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

Construit une instance de la classe Java qui est l'équivalent de Class et renvoie un QJniObject contenant l'objet JNI. Les arguments de args sont transmis au constructeur Java.

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

Cette fonction n'est disponible que si tous les args sont connus JNI Types.

Cette fonction a été introduite dans Qt 6.4.

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

Crée un QJniObject à partir de la référence JNI locale localRef. Cette fonction prend possession de localRef et le libère avant de revenir.

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

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

Crée une chaîne Java à partir de QString string et renvoie une QJniObject contenant cette chaîne.

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

Voir aussi toString().

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

Récupère la valeur du champ fieldName.

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

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

Récupère un objet JNI à partir du champ fieldName.

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

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

Récupère un objet JNI du champ fieldName avec signature.

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

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

Récupère la valeur du champ statique fieldName pour la classe Klass.

Klass Le champ statique doit être un type C++ avec une correspondance enregistrée avec un type Java.

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

Récupère la valeur du champ statique fieldName de la classe className.

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

Récupère la valeur du champ statique fieldName sur clazz.

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

Récupère l'objet du champ fieldName de la classe className.

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

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

Récupère l'objet du champ fieldName sur clazz.

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

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

Récupère un objet JNI du champ fieldName avec signature de la classe className.

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

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

Récupère un objet JNI du champ fieldName avec signature de la classe clazz.

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

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

Retourne vrai si la classe Java className est disponible.

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

bool QJniObject::isValid() const

Retourne true si cette instance contient un objet Java valide.

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

Renvoie l'objet détenu par QJniObject, soit sous forme de jobject, soit sous forme de type T. T peut être l'un des types suivants : 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

Renvoie l'objet de classe détenu par QJniObject en tant que jclass.

Cette fonction a été introduite dans Qt 6.2.

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

Définit la valeur de 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)

Définit la valeur de fieldName avec signature à 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)

Définit le champ statique fieldName de la classe Klass à value.

Klass doit être un type C++ avec une correspondance de type enregistrée vers un type Java.

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

Définit le champ statique fieldName de la classe className à value.

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

Définit le champ statique fieldName de la classe clazz à value.

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

Définit le champ statique fieldName de la classe className à value en utilisant le setter avec signature.

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

Définit le champ statique fieldName de la classe clazz à value en utilisant le setter avec signature.

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

Échange cet objet avec other. Cette opération est très rapide et n'échoue jamais.

Cette fonction a été introduite dans Qt 6.8.

QString QJniObject::toString() const

Renvoie une adresse QString contenant une représentation sous forme de chaîne de l'objet Java. L'appel de cette fonction sur un objet Java String est un moyen pratique d'obtenir les données réelles de la chaîne.

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

Voir également fromString().

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

Remplacer l'objet actuel par object. L'ancien objet Java sera libéré.