QJniObject Class

Documentation sur les fonctions membres

QJniObject::QJniObject()

Crée un objet JNI non valide.

Voir également isValid().

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

Crée un nouvel objet JNI en appelant le constructeur par défaut de ` className`.

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

[explicit] QJniObject::QJniObject(jclass clazz)

Crée un nouvel objet JNI en appelant le constructeur par défaut de ` clazz`.

QJniObject::QJniObject(jobject object)

Crée 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)

Crée un nouvel objet JNI en appelant le constructeur de ` className ` avec les arguments ` args`. Ce constructeur n'est disponible que si toutes les ` args ` sont connues ` 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)

Crée 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, ...)

Crée un nouvel objet JNI en appelant le constructeur de ` className `, avec ` signature ` spécifiant les types de tous les 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, ...)

Crée un nouvel objet JNI à partir de ` clazz ` en appelant le constructeur avec ` signature `, en spécifiant les types de tous les arguments suivants.

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

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

Crée une instance de ` QJniObject` par copie.

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

Crée par construction une instance de ` QJniObject`.

[noexcept] QJniObject::~QJniObject()

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

[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 de type void). Si Ret est de type jobject, la valeur renvoyée sera alors un QJniObject.

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

La signature de la méthode est déduite lors 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.

[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 ` methodName ` de l'objet avec ` signature ` spécifiant les types de tous les arguments suivants ` args`, et renvoie la valeur (à moins que `Ret` ne soit de type ` void`). Si `Ret` est de type `jobject`, la valeur renvoyée sera un ` 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 ` methodName ` de l'objet Java avec les arguments ` args ` et renvoie un nouvel objet ` 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 lors 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 ` de 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 ` methodName ` de l'objet Java avec ` signature `, en précisant 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 ` de la classe ` Klass ` et renvoie la valeur de type `Ret` (à moins que `Ret` ne soit de type ` void`). Si `Ret` est de type `jobject`, la valeur renvoyée sera un ` QJniObject`.

La signature de la méthode est déduite lors de la compilation à partir de Ret et des types de args. Klass doit être un type C++ disposant d’un mappage de type enregistré vers un type Java. Ret peut être un type compatible avec std::expected qui renvoie une valeur, ou un 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 ` de la classe ` className ` avec les arguments ` args`, et renvoie la valeur de type `Ret` (à moins que `Ret` ne soit de type ` void`). Si `Ret` est de type `jobject`, la valeur renvoyée sera un ` QJniObject`.

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

La signature de la méthode est déduite lors 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 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 de type `Ret` (à moins que `Ret` ne soit de type ` void`). Si `Ret` est de type `jobject`, la valeur renvoyée sera un ` 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 lors 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 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 les arguments qui suivent, et renvoie la valeur de type `Ret` (à moins que `Ret` ne soit de type ` void`). Si `Ret` est de type `jobject`, la valeur renvoyée sera alors un ` QJniObject`.

Utile lorsque clazz et methodId sont déjà mis en cache à la suite 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 de tous les arguments suivants ` args`. Renvoie le résultat de la méthode (sauf si `Ret` est ` void`). Si `Ret` est de type `jobject`, la valeur renvoyée sera alors 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 ` de ` clazz ` avec ` signature `, en spécifiant les types de tous les arguments suivants. Renvoie le résultat de la méthode (sauf si `Ret` est de type ` void`). Si `Ret` est de type `jobject`, la valeur renvoyée sera alors 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 l'methodName sur la classe className, en lui passant les arguments args, et renvoie un nouvel objet QJniObject pour l'objet Java renvoyé.

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

La signature de la méthode est déduite lors 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 l'methodName e sur clazz, en lui transmettant les arguments args, et renvoie un nouvel objet 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 les arguments qui suivent. Utile lorsque ` clazz ` et ` methodId ` sont déjà mis en cache à la suite 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 ` de la classe ` className `, en utilisant ` signature ` pour spécifier 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 `, en utilisant ` signature ` pour spécifier les types des arguments suivants.

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

Renvoie le nom de l'objet de classe détenu par l'QJniObject, sous la forme d'un objet de type ` QByteArray`.

Cette fonction a été introduite dans Qt 6.2.

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

Crée une instance de la classe Java équivalente à 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 objet ` QJniObject ` à partir de la référence JNI locale ` localRef`. Cette fonction prend possession de ` localRef ` et le libère avant de retourner.

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 l'objet QString string et renvoie un objet QJniObject contenant cette chaîne.

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

Voir également 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 à partir 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 » de la classe « Klass ».

Klass Ce champ doit être de type C++ et disposer d'un mappage de type enregistré vers 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 à partir 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 à partir 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 à partir du champ fieldName avec signature issu 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 à partir 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)

Renvoie « true » si la classe Java « className » est disponible.

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

bool QJniObject::isValid() const

Renvoie « 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 contenu dans l'QJniObject, soit sous forme de jobject, soit sous la forme du type T. T peut être l'un des éléments 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 l'QJniObject sous la forme d'un 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 » sur « 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 » sur « 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 sur la valeur value.

Klass Doit être un type C++ dont le mappage de type est enregistré 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 ` sur ` 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 ` sur ` value`.

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

Définit la propriété statique « fieldName » de la classe « className » sur la valeur « value » à l'aide du setter « signature ».

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

Définit la propriété statique « fieldName » de la classe « clazz » sur la valeur « value » à l'aide du setter « signature ».

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

Permute cet objet avec other. Cette opération est très rapide et ne peut jamais échouer.

Cette fonction a été introduite dans Qt 6.8.

QString QJniObject::toString() const

Renvoie un objet ` QString ` contenant la représentation sous forme de chaîne de caractères de l'objet Java. L'appel de cette fonction sur un objet `String` Java constitue 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 aussi ` fromString()`.

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

Cette opération attribue l'other à cette instance QJniObject.

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é.

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

Copie et attribue other à cette instance de QJniObject.