io.netty.util.concurrent.DefaultProgressivePromise Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of netty-common Show documentation
There is a newer version: 5.0.0.Alpha2
/*
 * Copyright 2013 The Netty Project
 *
 * The Netty Project licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package io.netty.util.concurrent;

import static io.netty.util.internal.ObjectUtil.checkPositiveOrZero;

public class DefaultProgressivePromise extends DefaultPromise implements ProgressivePromise {

    /**
     * Creates a new instance.
     *
     * It is preferable to use {@link EventExecutor#newProgressivePromise()} to create a new progressive promise
     *
     * @param executor
     *        the {@link EventExecutor} which is used to notify the promise when it progresses or it is complete
     */
    public DefaultProgressivePromise(EventExecutor executor) {
        super(executor);
    }

    protected DefaultProgressivePromise() { /* only for subclasses */ }

    @Override
    public ProgressivePromise setProgress(long progress, long total) {
        if (total < 0) {
            // total unknown
            total = -1; // normalize
            checkPositiveOrZero(progress, "progress");
        } else if (progress < 0 || progress > total) {
            throw new IllegalArgumentException(
                    "progress: " + progress + " (expected: 0 <= progress <= total (" + total + "))");
        }

        if (isDone()) {
            throw new IllegalStateException("complete already");
        }

        notifyProgressiveListeners(progress, total);
        return this;
    }

    @Override
    public boolean tryProgress(long progress, long total) {
        if (total < 0) {
            total = -1;
            if (progress < 0 || isDone()) {
                return false;
            }
        } else if (progress < 0 || progress > total || isDone()) {
            return false;
        }

        notifyProgressiveListeners(progress, total);
        return true;
    }

    @Override
    public ProgressivePromise addListener(GenericFutureListener> listener) {
        super.addListener(listener);
        return this;
    }

    @Override
    public ProgressivePromise addListeners(GenericFutureListener>... listeners) {
        super.addListeners(listeners);
        return this;
    }

    @Override
    public ProgressivePromise removeListener(GenericFutureListener> listener) {
        super.removeListener(listener);
        return this;
    }

    @Override
    public ProgressivePromise removeListeners(GenericFutureListener>... listeners) {
        super.removeListeners(listeners);
        return this;
    }

    @Override
    public ProgressivePromise sync() throws InterruptedException {
        super.sync();
        return this;
    }

    @Override
    public ProgressivePromise syncUninterruptibly() {
        super.syncUninterruptibly();
        return this;
    }

    @Override
    public ProgressivePromise await() throws InterruptedException {
        super.await();
        return this;
    }

    @Override
    public ProgressivePromise awaitUninterruptibly() {
        super.awaitUninterruptibly();
        return this;
    }

    @Override
    public ProgressivePromise setSuccess(V result) {
        super.setSuccess(result);
        return this;
    }

    @Override
    public ProgressivePromise setFailure(Throwable cause) {
        super.setFailure(cause);
        return this;
    }
}