io.qt.core.QPromise Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qtjambi Show documentation
QtJambi base module containing QtCore, QtGui and QtWidgets.
There is a newer version: 6.8.0
/****************************************************************************
**
** Copyright (C) 2009-2024 Dr. Peter Droste, Omix Visualization GmbH & Co. KG. All rights reserved.
**
** This file is part of Qt Jambi.
**
** $BEGIN_LICENSE$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
** 
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
** $END_LICENSE$
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
****************************************************************************/

package io.qt.core;

import java.util.Objects;

import io.qt.NativeAccess;
import io.qt.NonNull;
import io.qt.QNoImplementationException;
import io.qt.QtObject;
import io.qt.StrictNonNull;

/**
 * Way to store computation results to be accessed by QFuture
 * Java wrapper for Qt class QPromise
 */
public final class QPromise
{
    static {
        QtJambi_LibraryUtilities.initialize();
    }
    
    private static class NativeInstance extends QtObject{
        @NativeAccess
		private NativeInstance(QPrivateConstructor p) {
			super(p);
		}
        
        @NativeAccess
        private QPromise promise;
    }
    
    private final io.qt.core.QFutureInterfaceBase d;
    
    @NativeAccess
    private NativeInstance nativeInstance;
    
    public static QPromise createVoidPromise() {
    	return new QPromise<>(true);
    }
    
    /**
     * See QPromise::QPromise()
     */
    public QPromise(){
        super();
        d = new QFutureInterface<>();
        registerPromise(this);
    }
    
    private void registerPromise(QPromise promise) {
    	QFutureInterfaceBase d = promise.d;
        QtJambi_LibraryUtilities.internal.registerCleaner(promise, ()->{if(!d.isDisposed()){
        	d.reportFinished();
        }});
    }
    
	private QPromise(boolean isVoid){
        super();
        d = QFutureInterface.createVoidFutureInterface();
        registerPromise(this);
    }
    
    public QPromise(io.qt.core.@StrictNonNull QFutureInterface other){
    	d = other.clone();
    	registerPromise(this);
    }
    
    @NativeAccess
    private QPromise(io.qt.core.QFutureInterfaceBase other, boolean internal){
    	d = Objects.requireNonNull(other);
    }
    
    /**
     * See QPromise::finish()
     */
    @io.qt.QtUninvokable
    public final void finish(){
    	d.reportFinished();
    }
    
    /**
     * See QPromise::future()const
     */
    @io.qt.QtUninvokable
    public final io.qt.core.@NonNull QFuture future(){
    	return new QFuture<>(d.clone(), true);
    }
    
    /**
     * See QPromise::isCanceled()const
     */
    @io.qt.QtUninvokable
    public final boolean isCanceled(){
    	return d.isCanceled();
    }
    
    /**
     * See QPromise::setProgressRange(int,int)
     */
    @io.qt.QtUninvokable
    public final void setProgressRange(int minimum, int maximum){
    	d.setProgressRange(minimum, maximum);
    }
    
    /**
     * See QPromise::setProgressValue(int)
     */
    @io.qt.QtUninvokable
    public final void setProgressValue(int progressValue){
    	d.setProgressValue(progressValue);
    }
    
    /**
     * See QPromise::setProgressValueAndText(int,QString)
     */
    @io.qt.QtUninvokable
    public final void setProgressValueAndText(int progressValue, java.lang.String progressText){
    	d.setProgressValueAndText(progressValue, progressText);
    }
    
    /**
     * See QPromise::start()
     */
    @io.qt.QtUninvokable
    public final void start(){
    	d.reportStarted();
    }
    
    /**
     * See QPromise::suspendIfRequested()
     */
    @io.qt.QtUninvokable
    public final void suspendIfRequested(){
    	d.suspendIfRequested();
    }
    
    /**
     * See QPromise::swap(QPromise<T>&)
     */
    @io.qt.QtUninvokable
    public final void swap(io.qt.core.@StrictNonNull QPromise other){
        java.util.Objects.requireNonNull(other, "Argument 'other': null not expected.");
        d.swap(other.d);
    }
    
    @io.qt.QtUninvokable
    public final void setException(@StrictNonNull Throwable e) {
        d.reportException(e);
    }
    
    @io.qt.QtUninvokable
    public final boolean addResult(T result) {
        try {
			return QFutureInterface.reportResult(QtJambi_LibraryUtilities.internal.nativeId(d), result, -1);
		} catch (QNoImplementationException e) {
			throw new QNoImplementationException("addResult(T) not available for QPromise.");
		}
    }
    
    @io.qt.QtUninvokable
    public final boolean addResult(T result, int index) {
    	try{
    		return QFutureInterface.reportResult(QtJambi_LibraryUtilities.internal.nativeId(d), result, index);
    	} catch (QNoImplementationException e) {
			throw new QNoImplementationException("addResult(T, int) not available for QPromise.");
		}
    }
}