org.apache.ratis.io.CloseAsync Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ratis-common Show documentation

There is a newer version: 3.1.2

/*
 * 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.ratis.io;

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

/** Support the {@link CloseAsync#closeAsync()} method. */
public interface CloseAsync extends AutoCloseable {
  /** Close asynchronously. */
  CompletableFuture closeAsync();

  /**
   * The same as {@link AutoCloseable#close()}.
   *
   * The default implementation simply calls {@link CloseAsync#closeAsync()}
   * and then waits for the returned future to complete.
   */
  default void close() throws Exception {
    try {
      closeAsync().get();
    } catch (ExecutionException e) {
      final Throwable cause = e.getCause();
      throw cause instanceof Exception? (Exception)cause: e;
    }
  }
}