org.apache.sshd.common.future.WithException Maven / Gradle / Ivy
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.future;
/**
* Something that may carry a failure exception.
*
* @author Apache MINA SSHD Project
*/
public interface WithException {
/**
* Returns the cause of the failure.
*
* @return the {@link Throwable} of the failure, or {@code null} if not failed (yet).
*/
Throwable getException();
/**
* Sets the exception that caused the operation to fail.
*
* @param exception The {@link Throwable} to set; must be non-{@code null}
*/
void setException(Throwable exception);
}