org.apache.sshd.common.io.AbstractIoWriteFuture Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sshd-common Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF 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
 *
 * http://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 org.apache.sshd.common.io;

import java.io.IOException;
import java.util.Objects;

import org.apache.sshd.common.SshException;
import org.apache.sshd.common.future.CancelOption;
import org.apache.sshd.common.future.DefaultVerifiableSshFuture;

/**
 * @author Apache MINA SSHD Project
 */
public abstract class AbstractIoWriteFuture
        extends DefaultVerifiableSshFuture
        implements IoWriteFuture {
    protected AbstractIoWriteFuture(Object id, Object lock) {
        super(id, lock);
    }

    @Override
    public IoWriteFuture verify(long timeout, CancelOption... options) throws IOException {
        Boolean result = verifyResult(Boolean.class, timeout);
        if (!result) {
            throw formatExceptionMessage(
                    SshException::new,
                    "Write failed signalled while wait %d msec.",
                    timeout);
        }

        return this;
    }

    @Override
    public boolean isWritten() {
        Object value = getValue();
        return (value instanceof Boolean) && (Boolean) value;
    }

    @Override
    public Throwable getException() {
        Object v = getValue();
        if (v instanceof Throwable) {
            return (Throwable) v;
        } else {
            return null;
        }
    }

    public static IoWriteFuture fulfilled(Object id, Object value) {
        AbstractIoWriteFuture result = new AbstractIoWriteFuture(id, null) {
            // Nothing extra
        };
        result.setValue(Objects.requireNonNull(value));
        return result;
    }
}